Class CreateApiDestinationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateApiDestinationRequest.Builder,
CreateApiDestinationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ARN of the connection to use for the API destination.final String
A description for the API destination to create.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.final String
The method to use for the request to the HTTP invocation endpoint.final String
The URL to the HTTP invocation endpoint for the API destination.final Integer
The maximum number of requests per second to send to the HTTP invocation endpoint.final String
name()
The name for the API destination to create.static Class
<? extends CreateApiDestinationRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name for the API destination to create.
- Returns:
- The name for the API destination to create.
-
description
A description for the API destination to create.
- Returns:
- A description for the API destination to create.
-
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
The URL to the HTTP invocation endpoint for the API destination.
- Returns:
- The URL to the HTTP invocation endpoint for the API destination.
-
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 returnApiDestinationHttpMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpMethodAsString()
.- Returns:
- The method to use for the request to the HTTP invocation endpoint.
- See Also:
-
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 returnApiDestinationHttpMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpMethodAsString()
.- Returns:
- The method to use for the request to the HTTP invocation endpoint.
- See Also:
-
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
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 interfaceToCopyableBuilder<CreateApiDestinationRequest.Builder,
CreateApiDestinationRequest> - Specified by:
toBuilder
in classEventBridgeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-