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

Interface Stage.Builder

All Superinterfaces:

CopyableBuilder<Stage.Builder,Stage>, SdkBuilder<Stage.Builder,Stage>

Enclosing class:

Stage

public static interface Stage.Builder
extends CopyableBuilder<Stage.Builder,Stage>

Method Summary

Modifier and Type	Method	Description
Stage.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled)	Specifies whether a cache cluster is enabled for the stage.
Stage.Builder	cacheClusterSize(String cacheClusterSize)	The size of the cache cluster for the stage, if enabled.
Stage.Builder	cacheClusterStatus(String cacheClusterStatus)	The status of the cache cluster for the stage, if enabled.
Stage.Builder	cacheClusterStatus(CacheClusterStatus cacheClusterStatus)	The status of the cache cluster for the stage, if enabled.
Stage.Builder	clientCertificateId(String clientCertificateId)	The identifier of a client certificate for an API stage.
Stage.Builder	createdDate(Date createdDate)	The timestamp when the stage was created.
Stage.Builder	deploymentId(String deploymentId)	The identifier of the Deployment that the stage points to.
Stage.Builder	description(String description)	The stage's description.
Stage.Builder	documentationVersion(String documentationVersion)	The version of the associated API documentation.
Stage.Builder	lastUpdatedDate(Date lastUpdatedDate)	The timestamp when the stage last updated.
Stage.Builder	methodSettings(Map<String,MethodSetting> methodSettings)	A map that defines the method settings for a Stage resource.
Stage.Builder	stageName(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	variables(Map<String,String> variables)	A map that defines the stage variables for a Stage resource.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

deploymentId

Stage.Builder deploymentId(String deploymentId)

The identifier of the Deployment that the stage points to.

Parameters:

deploymentId - The identifier of the Deployment that the stage points to.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientCertificateId

Stage.Builder clientCertificateId(String clientCertificateId)

The identifier of a client certificate for an API stage.

Parameters:

clientCertificateId - The identifier of a client certificate for an API stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

stageName

Stage.Builder stageName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

description

Stage.Builder description(String description)

The stage's description.

Parameters:

description - The stage's description.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheClusterEnabled

Stage.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Specifies whether a cache cluster is enabled for the stage.

Parameters:

cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheClusterSize

Stage.Builder cacheClusterSize(String cacheClusterSize)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheClusterStatus

Stage.Builder cacheClusterStatus(String cacheClusterStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CacheClusterStatus

cacheClusterStatus

Stage.Builder cacheClusterStatus(CacheClusterStatus cacheClusterStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CacheClusterStatus

methodSettings

Stage.Builder methodSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

variables

Stage.Builder variables(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-._~:/?#&=,]+.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

documentationVersion

Stage.Builder documentationVersion(String documentationVersion)

The version of the associated API documentation.

Parameters:

documentationVersion - The version of the associated API documentation.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdDate

Stage.Builder createdDate(Date createdDate)

The timestamp when the stage was created.

Parameters:

createdDate - The timestamp when the stage was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdatedDate

Stage.Builder lastUpdatedDate(Date lastUpdatedDate)

The timestamp when the stage last updated.

Parameters:

lastUpdatedDate - The timestamp when the stage last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.