Package software.amazon.awssdk.services.eventbridge.model

Class DescribeApiDestinationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.eventbridge.model.EventBridgeResponse

software.amazon.awssdk.services.eventbridge.model.DescribeApiDestinationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeApiDestinationResponse
extends EventBridgeResponse
implements ToCopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeApiDestinationResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	apiDestinationArn()	The ARN of the API destination retrieved.
ApiDestinationState	apiDestinationState()	The state of the API destination retrieved.
String	apiDestinationStateAsString()	The state of the API destination retrieved.
static DescribeApiDestinationResponse.Builder	builder()
String	connectionArn()	The ARN of the connection specified for the API destination retrieved.
Instant	creationTime()	A time stamp for the time that the API destination was created.
String	description()	The description for the API destination retrieved.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ApiDestinationHttpMethod	httpMethod()	The method to use to connect to the HTTP endpoint.
String	httpMethodAsString()	The method to use to connect to the HTTP endpoint.
String	invocationEndpoint()	The URL to use to connect to the HTTP endpoint.
Integer	invocationRateLimitPerSecond()	The maximum number of invocations per second to specified for the API destination.
Instant	lastModifiedTime()	A time stamp for the time that the API destination was last modified.
String	name()	The name of the API destination retrieved.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeApiDestinationResponse.Builder>	serializableBuilderClass()
DescribeApiDestinationResponse.Builder	toBuilder()
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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

apiDestinationArn

public final String apiDestinationArn()

The ARN of the API destination retrieved.

Returns:

The ARN of the API destination retrieved.

name

public final String name()

The name of the API destination retrieved.

Returns:

The name of the API destination retrieved.

description

public final String description()

The description for the API destination retrieved.

Returns:

The description for the API destination retrieved.

apiDestinationState

public final ApiDestinationState 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 return ApiDestinationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiDestinationStateAsString().

Returns:

The state of the API destination retrieved.

See Also:

ApiDestinationState

apiDestinationStateAsString

public final String 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 return ApiDestinationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiDestinationStateAsString().

Returns:

The state of the API destination retrieved.

See Also:

ApiDestinationState

connectionArn

public final String 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

public final String invocationEndpoint()

The URL to use to connect to the HTTP endpoint.

Returns:

The URL to use to connect to the HTTP endpoint.

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:

ApiDestinationHttpMethod

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:

ApiDestinationHttpMethod

invocationRateLimitPerSecond

public final Integer 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

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 DescribeApiDestinationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeApiDestinationResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo