Class ApiDestination

java.lang.Object
software.amazon.awssdk.services.cloudwatchevents.model.ApiDestination
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApiDestination.Builder,ApiDestination>
@Generated("software.amazon.awssdk:codegen") public final class ApiDestination extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApiDestination.Builder,ApiDestination>

Contains details about an API destination.

See Also:

  • Method Details

    • apiDestinationArn

      public final String apiDestinationArn()

      The ARN of the API destination.

      Returns:
      The ARN of the API destination.

    • name

      public final String name()

      The name of the API destination.

      Returns:
      The name of the API destination.

    • apiDestinationState

      public final ApiDestinationState apiDestinationState()

      The state of the API destination.

      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.
      See Also:

    • apiDestinationStateAsString

      public final String apiDestinationStateAsString()

      The state of the API destination.

      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.
      See Also:

    • connectionArn

      public final String connectionArn()

      The ARN of the connection specified for the API destination.

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

    • invocationEndpoint

      public final String invocationEndpoint()

      The URL to the endpoint for the API destination.

      Returns:
      The URL to the endpoint for the API destination.

    • 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 send to the HTTP endpoint.

      Returns:
      The maximum number of invocations per second to send to the HTTP endpoint.

    • 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 ApiDestination.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<ApiDestination.Builder,ApiDestination>
      Returns:
      a builder for type T

    • builder

      public static ApiDestination.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.