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

Class CreateApiDestinationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest

software.amazon.awssdk.services.eventbridge.model.CreateApiDestinationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateApiDestinationRequest.Builder,CreateApiDestinationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateApiDestinationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateApiDestinationRequest.Builder	builder()
String	connectionArn()	The ARN of the connection to use for the API destination.
String	description()	A description for the API destination to create.
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 for the request to the HTTP invocation endpoint.
String	httpMethodAsString()	The method to use for the request to the HTTP invocation endpoint.
String	invocationEndpoint()	The URL to the HTTP invocation endpoint for the API destination.
Integer	invocationRateLimitPerSecond()	The maximum number of requests per second to send to the HTTP invocation endpoint.
String	name()	The name for the API destination to create.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateApiDestinationRequest.Builder>	serializableBuilderClass()
CreateApiDestinationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

The name for the API destination to create.

Returns:

The name for the API destination to create.

description

public final String description()

A description for the API destination to create.

Returns:

A description for the API destination to create.

connectionArn

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

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

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

Returns:

The method to use for the request to the HTTP invocation endpoint.

See Also:

ApiDestinationHttpMethod

httpMethodAsString

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

Returns:

The method to use for the request to the HTTP invocation endpoint.

See Also:

ApiDestinationHttpMethod

invocationRateLimitPerSecond

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

public CreateApiDestinationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateApiDestinationRequest.Builder,CreateApiDestinationRequest>

Specified by:

toBuilder in class EventBridgeRequest

builder

public static CreateApiDestinationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo