software.amazon.awssdk.services.apigatewayv2.model

Class CreateStageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request

software.amazon.awssdk.services.apigatewayv2.model.CreateStageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStageRequest
extends ApiGatewayV2Request
implements ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateStageRequest.Builder

Method Summary

Modifier and Type	Method and Description
AccessLogSettings	accessLogSettings() Settings for logging access in this stage.
String	apiId() The API identifier.
static CreateStageRequest.Builder	builder()
String	clientCertificateId() The identifier of a client certificate for a Stage.
RouteSettings	defaultRouteSettings() The default route settings for the stage.
String	deploymentId() The deployment identifier of the API stage.
String	description() The description for the API stage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,RouteSettings>	routeSettings() Route settings for the stage.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateStageRequest.Builder>	serializableBuilderClass()
String	stageName() The name of the stage.
Map<String,String>	stageVariables() A map that defines the stage variables for a Stage.
Map<String,String>	tags() The key-value map of strings.
CreateStageRequest.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

accessLogSettings

public AccessLogSettings accessLogSettings()

Settings for logging access in this stage.

Returns:

Settings for logging access in this stage.

apiId

public String apiId()

The API identifier.

Returns:

The API identifier.

clientCertificateId

public String clientCertificateId()

The identifier of a client certificate for a Stage.

Returns:

The identifier of a client certificate for a Stage.

defaultRouteSettings

public RouteSettings defaultRouteSettings()

The default route settings for the stage.

Returns:

The default route settings for the stage.

deploymentId

public String deploymentId()

The deployment identifier of the API stage.

Returns:

The deployment identifier of the API stage.

description

public String description()

The description for the API stage.

Returns:

The description for the API stage.

routeSettings

public Map<String,RouteSettings> routeSettings()

Route settings for the stage.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Route settings for the stage.

stageName

public String stageName()

The name of the stage.

Returns:

The name of the stage.

stageVariables

public Map<String,String> stageVariables()

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

tags

public Map<String,String> tags()

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

toBuilder

public CreateStageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

builder

public static CreateStageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo