Class DescribeApiDestinationResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeApiDestinationResponse.Builder,
DescribeApiDestinationResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of the API destination retrieved.final ApiDestinationState
The state of the API destination retrieved.final String
The state of the API destination retrieved.builder()
final String
The ARN of the connection specified for the API destination retrieved.final Instant
A time stamp for the time that the API destination was created.final String
The description for the API destination retrieved.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 extendsSdkResponse
.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 use to connect to the HTTP endpoint.final Integer
The maximum number of invocations per second to specified for the API destination.final Instant
A time stamp for the time that the API destination was last modified.final String
name()
The name of the API destination retrieved.static Class
<? extends DescribeApiDestinationResponse.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.services.eventbridge.model.EventBridgeResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiDestinationArn
The ARN of the API destination retrieved.
- Returns:
- The ARN of the API destination retrieved.
-
name
The name of the API destination retrieved.
- Returns:
- The name of the API destination retrieved.
-
description
The description for the API destination retrieved.
- Returns:
- The description for the API destination retrieved.
-
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 returnApiDestinationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiDestinationStateAsString()
.- Returns:
- The state of the API destination retrieved.
- See Also:
-
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 returnApiDestinationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiDestinationStateAsString()
.- Returns:
- The state of the API destination retrieved.
- See Also:
-
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
The URL to use to connect to the HTTP endpoint.
- Returns:
- The URL to use to connect to the HTTP endpoint.
-
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 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
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<DescribeApiDestinationResponse.Builder,
DescribeApiDestinationResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-