Package software.amazon.awssdk.services.apigateway.model

Class CreateStageRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.CreateStageRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

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

Requests Amazon API Gateway to create a Stage resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateStageRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreateStageRequest.Builder	builder()
Boolean	cacheClusterEnabled()	Whether cache clustering is enabled for the stage.
String	cacheClusterSize()	The stage's cache cluster size.
String	deploymentId()	The identifier of the Deployment resource for the Stage resource.
String	description()	The description of the Stage resource.
String	documentationVersion()	The version of the associated API documentation.
boolean	equals(Object obj)
int	hashCode()
String	restApiId()	The identifier of the RestApi resource for the Stage resource to create.
static Class<? extends CreateStageRequest.Builder>	serializableBuilderClass()
String	stageName()	The name for the Stage resource.
CreateStageRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Map<String,String>	variables()	A map that defines the stage variables for the new Stage resource.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

The identifier of the RestApi resource for the Stage resource to create.

Returns:

The identifier of the RestApi resource for the Stage resource to create.

stageName

public String stageName()

The name for the Stage resource.

Returns:

The name for the Stage resource.

deploymentId

public String deploymentId()

The identifier of the Deployment resource for the Stage resource.

Returns:

The identifier of the Deployment resource for the Stage resource.

description

public String description()

The description of the Stage resource.

Returns:

The description of the Stage resource.

cacheClusterEnabled

public Boolean cacheClusterEnabled()

Whether cache clustering is enabled for the stage.

Returns:

Whether cache clustering is enabled for the stage.

cacheClusterSize

public String cacheClusterSize()

The stage's cache cluster size.

Returns:

The stage's cache cluster size.

variables

public Map<String,String> variables()

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

Returns:

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

documentationVersion

public String documentationVersion()

The version of the associated API documentation.

Returns:

The version of the associated API documentation.

toBuilder

public CreateStageRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Returns:

a builder for type T

builder

public static CreateStageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object