Package software.amazon.awssdk.services.migrationhubrefactorspaces.model

Class ApiGatewayProxyInput

java.lang.Object

software.amazon.awssdk.services.migrationhubrefactorspaces.model.ApiGatewayProxyInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ApiGatewayProxyInput.Builder,ApiGatewayProxyInput>

@Generated("software.amazon.awssdk:codegen")
public final class ApiGatewayProxyInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ApiGatewayProxyInput.Builder,ApiGatewayProxyInput>

A wrapper object holding the Amazon API Gateway endpoint input.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApiGatewayProxyInput.Builder

Method Summary

Modifier and Type	Method	Description
static ApiGatewayProxyInput.Builder	builder()
ApiGatewayEndpointType	endpointType()	The type of endpoint to use for the API Gateway proxy.
String	endpointTypeAsString()	The type of endpoint to use for the API Gateway proxy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ApiGatewayProxyInput.Builder>	serializableBuilderClass()
String	stageName()	The name of the API Gateway stage.
ApiGatewayProxyInput.Builder	toBuilder()
String	toString()	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

endpointType

public final ApiGatewayEndpointType endpointType()

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

If the service returns an enum value that is not available in the current SDK version, endpointType will return ApiGatewayEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

Returns:

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

See Also:

ApiGatewayEndpointType

endpointTypeAsString

public final String endpointTypeAsString()

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

If the service returns an enum value that is not available in the current SDK version, endpointType will return ApiGatewayEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

Returns:

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

See Also:

ApiGatewayEndpointType

stageName

public final String stageName()

The name of the API Gateway stage. The name defaults to prod.

Returns:

The name of the API Gateway stage. The name defaults to prod.

toBuilder

public ApiGatewayProxyInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApiGatewayProxyInput.Builder,ApiGatewayProxyInput>

builder

public static ApiGatewayProxyInput.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo