Class ApiDestination
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ApiDestination.Builder,
ApiDestination>
Contains details about an API destination.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of the API destination.final ApiDestinationState
The state of the API destination.final String
The state of the API destination.static ApiDestination.Builder
builder()
final String
The ARN of the connection specified for the API destination.final Instant
A time stamp for the time that the API destination was created.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) final int
hashCode()
final ApiDestinationHttpMethod
The method to use to connect to the HTTP endpoint.final String
The method to use to connect to the HTTP endpoint.final String
The URL to the endpoint for the API destination.final Integer
The maximum number of invocations per second to send to the HTTP endpoint.final Instant
A time stamp for the time that the API destination was last modified.final String
name()
The name of the API destination.static Class
<? extends ApiDestination.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiDestinationArn
The ARN of the API destination.
- Returns:
- The ARN of the API destination.
-
name
The name of the API destination.
- Returns:
- The name of the API destination.
-
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 returnApiDestinationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiDestinationStateAsString()
.- Returns:
- The state of the API destination.
- See Also:
-
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 returnApiDestinationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiDestinationStateAsString()
.- Returns:
- The state of the API destination.
- See Also:
-
connectionArn
The ARN of the connection specified for the API destination.
- Returns:
- The ARN of the connection specified for the API destination.
-
invocationEndpoint
The URL to the endpoint for the API destination.
- Returns:
- The URL to the endpoint for the API destination.
-
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 returnApiDestinationHttpMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpMethodAsString()
.- Returns:
- The method to use to connect to the HTTP endpoint.
- See Also:
-
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 returnApiDestinationHttpMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpMethodAsString()
.- Returns:
- The method to use to connect to the HTTP endpoint.
- See Also:
-
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
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
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
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<ApiDestination.Builder,
ApiDestination> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-