Class DescribeApiDestinationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsResponse
software.amazon.awssdk.services.cloudwatchevents.model.DescribeApiDestinationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeApiDestinationResponse extends CloudWatchEventsResponse implements ToCopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>

  • Method Details

    • apiDestinationArn

      public final String apiDestinationArn()

      The ARN of the API destination retrieved.

      Returns:
      The ARN of the API destination retrieved.

    • name

      public final String name()

      The name of the API destination retrieved.

      Returns:
      The name of the API destination retrieved.

    • description

      public final String description()

      The description for the API destination retrieved.

      Returns:
      The description for the API destination retrieved.

    • apiDestinationState

      public final ApiDestinationState apiDestinationState()

      The state of the API destination retrieved.

      If the service returns an enum value that is not available in the current SDK version, apiDestinationState will return ApiDestinationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiDestinationStateAsString().

      Returns:
      The state of the API destination retrieved.
      See Also:

    • apiDestinationStateAsString

      public final String apiDestinationStateAsString()

      The state of the API destination retrieved.

      If the service returns an enum value that is not available in the current SDK version, apiDestinationState will return ApiDestinationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiDestinationStateAsString().

      Returns:
      The state of the API destination retrieved.
      See Also:

    • connectionArn

      public final String connectionArn()

      The ARN of the connection specified for the API destination retrieved.

      Returns:
      The ARN of the connection specified for the API destination retrieved.

    • invocationEndpoint

      public final String invocationEndpoint()

      The URL to use to connect to the HTTP endpoint.

      Returns:
      The URL to use to connect to the HTTP endpoint.

    • httpMethod

      public final ApiDestinationHttpMethod httpMethod()

      The method to use to connect to the HTTP endpoint.

      If the service returns an enum value that is not available in the current SDK version, httpMethod will return ApiDestinationHttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpMethodAsString().

      Returns:
      The method to use to connect to the HTTP endpoint.
      See Also:

    • httpMethodAsString

      public final String httpMethodAsString()

      The method to use to connect to the HTTP endpoint.

      If the service returns an enum value that is not available in the current SDK version, httpMethod will return ApiDestinationHttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpMethodAsString().

      Returns:
      The method to use to connect to the HTTP endpoint.
      See Also:

    • invocationRateLimitPerSecond

      public final Integer invocationRateLimitPerSecond()

      The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

      Returns:
      The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

    • creationTime

      public final Instant creationTime()

      A time stamp for the time that the API destination was created.

      Returns:
      A time stamp for the time that the API destination was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      A time stamp for the time that the API destination was last modified.

      Returns:
      A time stamp for the time that the API destination was last modified.

    • toBuilder

      public DescribeApiDestinationResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeApiDestinationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeApiDestinationResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.