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

Class Stage

java.lang.Object

software.amazon.awssdk.services.apigateway.model.Stage

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Stage.Builder,Stage>

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

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Stage.Builder

Method Summary

Modifier and Type	Method	Description
static Stage.Builder	builder()
Boolean	cacheClusterEnabled()	Specifies whether a cache cluster is enabled for the stage.
String	cacheClusterSize()	The size of the cache cluster for the stage, if enabled.
String	cacheClusterStatus()	The status of the cache cluster for the stage, if enabled.
String	clientCertificateId()	The identifier of a client certificate for an API stage.
Date	createdDate()	The timestamp when the stage was created.
String	deploymentId()	The identifier of the Deployment that the stage points to.
String	description()	The stage's description.
String	documentationVersion()	The version of the associated API documentation.
boolean	equals(Object obj)
int	hashCode()
Date	lastUpdatedDate()	The timestamp when the stage last updated.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Map<String,MethodSetting>	methodSettings()	A map that defines the method settings for a Stage resource.
static Class<? extends Stage.Builder>	serializableBuilderClass()
String	stageName()	The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
Stage.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 a Stage resource.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

deploymentId

public String deploymentId()

The identifier of the Deployment that the stage points to.

Returns:

The identifier of the Deployment that the stage points to.

clientCertificateId

public String clientCertificateId()

The identifier of a client certificate for an API stage.

Returns:

The identifier of a client certificate for an API stage.

stageName

public String stageName()

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

Returns:

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

description

public String description()

The stage's description.

Returns:

The stage's description.

cacheClusterEnabled

public Boolean cacheClusterEnabled()

Specifies whether a cache cluster is enabled for the stage.

Returns:

Specifies whether a cache cluster is enabled for the stage.

cacheClusterSize

public String cacheClusterSize()

The size of the cache cluster for the stage, if enabled.

Returns:

The size of the cache cluster for the stage, if enabled.

cacheClusterStatus

public String cacheClusterStatus()

The status of the cache cluster for the stage, if enabled.

Returns:

The status of the cache cluster for the stage, if enabled.

See Also:

CacheClusterStatus

methodSettings

public Map<String,MethodSetting> methodSettings()

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

Returns:

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

variables

public Map<String,String> variables()

A map that defines the stage variables for a 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 a 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.

createdDate

public Date createdDate()

The timestamp when the stage was created.

Returns:

The timestamp when the stage was created.

lastUpdatedDate

public Date lastUpdatedDate()

The timestamp when the stage last updated.

Returns:

The timestamp when the stage last updated.

toBuilder

public Stage.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<Stage.Builder,Stage>

Returns:

a builder for type T

builder

public static Stage.Builder builder()

serializableBuilderClass

public static Class<? extends Stage.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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.