software.amazon.awssdk.services.apigateway.model

Interface CreateStageRequest.Builder

All Superinterfaces:

APIGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>, SdkBuilder<CreateStageRequest.Builder,CreateStageRequest>, SdkRequest.Builder

Enclosing class:

CreateStageRequest

public static interface CreateStageRequest.Builder
extends APIGatewayRequest.Builder, CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Method Summary

Modifier and Type	Method and Description
CreateStageRequest.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) Whether cache clustering is enabled for the stage.
CreateStageRequest.Builder	cacheClusterSize(String cacheClusterSize) The stage's cache cluster size.
CreateStageRequest.Builder	deploymentId(String deploymentId) The identifier of the Deployment resource for the Stage resource.
CreateStageRequest.Builder	description(String description) The description of the Stage resource.
CreateStageRequest.Builder	documentationVersion(String documentationVersion) The version of the associated API documentation.
CreateStageRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CreateStageRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
CreateStageRequest.Builder	restApiId(String restApiId) The string identifier of the associated RestApi.
CreateStageRequest.Builder	stageName(String stageName) The name for the Stage resource.
CreateStageRequest.Builder	variables(Map<String,String> variables) A map that defines the stage variables for the new Stage resource.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.APIGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

restApiId

CreateStageRequest.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

stageName

CreateStageRequest.Builder stageName(String stageName)

The name for the Stage resource.

Parameters:

stageName - The name for the Stage resource.

Returns:

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

deploymentId

CreateStageRequest.Builder deploymentId(String deploymentId)

The identifier of the Deployment resource for the Stage resource.

Parameters:

deploymentId - The identifier of the Deployment resource for the Stage resource.

Returns:

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

description

CreateStageRequest.Builder description(String description)

The description of the Stage resource.

Parameters:

description - The description of the Stage resource.

Returns:

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

cacheClusterEnabled

CreateStageRequest.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Whether cache clustering is enabled for the stage.

Parameters:

cacheClusterEnabled - Whether cache clustering is enabled for the stage.

Returns:

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

cacheClusterSize

CreateStageRequest.Builder cacheClusterSize(String cacheClusterSize)

The stage's cache cluster size.

Parameters:

cacheClusterSize - The stage's cache cluster size.

Returns:

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

variables

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

Parameters:

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:

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

documentationVersion

CreateStageRequest.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.

requestOverrideConfig

CreateStageRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CreateStageRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.