Class ApiDestination
- java.lang.Object
-
- software.amazon.awssdk.services.eventbridge.model.ApiDestination
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ApiDestination.Builder,ApiDestination>
@Generated("software.amazon.awssdk:codegen") public final class ApiDestination extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApiDestination.Builder,ApiDestination>
Contains details about an API destination.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceApiDestination.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringapiDestinationArn()The ARN of the API destination.ApiDestinationStateapiDestinationState()The state of the API destination.StringapiDestinationStateAsString()The state of the API destination.static ApiDestination.Builderbuilder()StringconnectionArn()The ARN of the connection specified for the API destination.InstantcreationTime()A time stamp for the time that the API destination was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()ApiDestinationHttpMethodhttpMethod()The method to use to connect to the HTTP endpoint.StringhttpMethodAsString()The method to use to connect to the HTTP endpoint.StringinvocationEndpoint()The URL to the endpoint for the API destination.IntegerinvocationRateLimitPerSecond()The maximum number of invocations per second to send to the HTTP endpoint.InstantlastModifiedTime()A time stamp for the time that the API destination was last modified.Stringname()The name of the API destination.List<SdkField<?>>sdkFields()static Class<? extends ApiDestination.Builder>serializableBuilderClass()ApiDestination.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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.
- Returns:
- The ARN of the API destination.
-
name
public final String name()
The name of the API destination.
- Returns:
- The name of the API destination.
-
apiDestinationState
public final ApiDestinationState apiDestinationState()
The state of the API destination.
If the service returns an enum value that is not available in the current SDK version,
apiDestinationStatewill returnApiDestinationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromapiDestinationStateAsString().- Returns:
- The state of the API destination.
- See Also:
ApiDestinationState
-
apiDestinationStateAsString
public final String apiDestinationStateAsString()
The state of the API destination.
If the service returns an enum value that is not available in the current SDK version,
apiDestinationStatewill returnApiDestinationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromapiDestinationStateAsString().- Returns:
- The state of the API destination.
- See Also:
ApiDestinationState
-
connectionArn
public final String connectionArn()
The ARN of the connection specified for the API destination.
- Returns:
- The ARN of the connection specified for the API destination.
-
invocationEndpoint
public final String invocationEndpoint()
The URL to the endpoint for the API destination.
- Returns:
- The URL to the endpoint for the API destination.
-
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,
httpMethodwill 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:
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,
httpMethodwill 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:
ApiDestinationHttpMethod
-
invocationRateLimitPerSecond
public final Integer 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
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 ApiDestination.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ApiDestination.Builder,ApiDestination>
-
builder
public static ApiDestination.Builder builder()
-
serializableBuilderClass
public static Class<? extends ApiDestination.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-