Class CreateApiDestinationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest
software.amazon.awssdk.services.eventbridge.model.CreateApiDestinationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateApiDestinationRequest.Builder,CreateApiDestinationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateApiDestinationRequest extends EventBridgeRequest implements ToCopyableBuilder<CreateApiDestinationRequest.Builder,CreateApiDestinationRequest>

  • Method Details

    • name

      public final String name()

      The name for the API destination to create.

      Returns:
      The name for the API destination to create.

    • description

      public final String description()

      A description for the API destination to create.

      Returns:
      A description for the API destination to create.

    • connectionArn

      public final String connectionArn()

      The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

      Returns:
      The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

    • invocationEndpoint

      public final String invocationEndpoint()

      The URL to the HTTP invocation endpoint for the API destination.

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

    • httpMethod

      public final ApiDestinationHttpMethod httpMethod()

      The method to use for the request to the HTTP invocation 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 for the request to the HTTP invocation endpoint.
      See Also:

    • httpMethodAsString

      public final String httpMethodAsString()

      The method to use for the request to the HTTP invocation 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 for the request to the HTTP invocation endpoint.
      See Also:

    • invocationRateLimitPerSecond

      public final Integer invocationRateLimitPerSecond()

      The maximum number of requests per second to send to the HTTP invocation endpoint.

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

    • toBuilder

      public CreateApiDestinationRequest.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<CreateApiDestinationRequest.Builder,CreateApiDestinationRequest>
      Specified by:
      toBuilder in class EventBridgeRequest
      Returns:
      a builder for type T

    • builder

      public static CreateApiDestinationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.