software.amazon.awssdk.services.apigateway.model

Interface CreateStageResponse.Builder

All Superinterfaces:

ApiGatewayResponse.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<CreateStageResponse.Builder,CreateStageResponse>, SdkBuilder<CreateStageResponse.Builder,CreateStageResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CreateStageResponse

public static interface CreateStageResponse.Builder
extends ApiGatewayResponse.Builder, SdkPojo, CopyableBuilder<CreateStageResponse.Builder,CreateStageResponse>

Method Summary

Modifier and Type	Method and Description
CreateStageResponse.Builder	accessLogSettings(AccessLogSettings accessLogSettings) Settings for logging access in this stage.
default CreateStageResponse.Builder	accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings) Settings for logging access in this stage.
CreateStageResponse.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) Specifies whether a cache cluster is enabled for the stage.
CreateStageResponse.Builder	cacheClusterSize(String cacheClusterSize) The stage's cache capacity in GB.
CreateStageResponse.Builder	cacheClusterStatus(CacheClusterStatus cacheClusterStatus) The status of the cache cluster for the stage, if enabled.
CreateStageResponse.Builder	cacheClusterStatus(String cacheClusterStatus) The status of the cache cluster for the stage, if enabled.
CreateStageResponse.Builder	canarySettings(CanarySettings canarySettings) Settings for the canary deployment in this stage.
default CreateStageResponse.Builder	canarySettings(Consumer<CanarySettings.Builder> canarySettings) Settings for the canary deployment in this stage.
CreateStageResponse.Builder	clientCertificateId(String clientCertificateId) The identifier of a client certificate for an API stage.
CreateStageResponse.Builder	createdDate(Instant createdDate) The timestamp when the stage was created.
CreateStageResponse.Builder	deploymentId(String deploymentId) The identifier of the Deployment that the stage points to.
CreateStageResponse.Builder	description(String description) The stage's description.
CreateStageResponse.Builder	documentationVersion(String documentationVersion) The version of the associated API documentation.
CreateStageResponse.Builder	lastUpdatedDate(Instant lastUpdatedDate) The timestamp when the stage last updated.
CreateStageResponse.Builder	methodSettings(Map<String,MethodSetting> methodSettings) A map that defines the method settings for a Stage resource.
CreateStageResponse.Builder	stageName(String stageName) The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
CreateStageResponse.Builder	tags(Map<String,String> tags) The collection of tags.
CreateStageResponse.Builder	tracingEnabled(Boolean tracingEnabled) Specifies whether active tracing with X-ray is enabled for the Stage.
CreateStageResponse.Builder	variables(Map<String,String> variables) A map that defines the stage variables for a Stage resource.
CreateStageResponse.Builder	webAclArn(String webAclArn) The ARN of the WebAcl associated with the Stage.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

deploymentId

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

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

CreateStageResponse.Builder stageName(String stageName)

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Parameters:

stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns:

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

description

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

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

CreateStageResponse.Builder cacheClusterSize(String cacheClusterSize)

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

Parameters:

cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

Returns:

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

cacheClusterStatus

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

cacheClusterStatus

CreateStageResponse.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, CacheClusterStatus

methodSettings

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

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

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

accessLogSettings

CreateStageResponse.Builder accessLogSettings(AccessLogSettings accessLogSettings)

Settings for logging access in this stage.

Parameters:

accessLogSettings - Settings for logging access in this stage.

Returns:

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

accessLogSettings

default CreateStageResponse.Builder accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)

Settings for logging access in this stage.

This is a convenience method that creates an instance of the AccessLogSettings.Builder avoiding the need to create one manually via AccessLogSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessLogSettings(AccessLogSettings).

Parameters:

accessLogSettings - a consumer that will call methods on AccessLogSettings.Builder

Returns:

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

See Also:

accessLogSettings(AccessLogSettings)

canarySettings

CreateStageResponse.Builder canarySettings(CanarySettings canarySettings)

Settings for the canary deployment in this stage.

Parameters:

canarySettings - Settings for the canary deployment in this stage.

Returns:

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

canarySettings

default CreateStageResponse.Builder canarySettings(Consumer<CanarySettings.Builder> canarySettings)

Settings for the canary deployment in this stage.

This is a convenience method that creates an instance of the CanarySettings.Builder avoiding the need to create one manually via CanarySettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to canarySettings(CanarySettings).

Parameters:

canarySettings - a consumer that will call methods on CanarySettings.Builder

Returns:

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

See Also:

canarySettings(CanarySettings)

tracingEnabled

CreateStageResponse.Builder tracingEnabled(Boolean tracingEnabled)

Specifies whether active tracing with X-ray is enabled for the Stage.

Parameters:

tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

Returns:

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

webAclArn

CreateStageResponse.Builder webAclArn(String webAclArn)

The ARN of the WebAcl associated with the Stage.

Parameters:

webAclArn - The ARN of the WebAcl associated with the Stage.

Returns:

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

tags

CreateStageResponse.Builder tags(Map<String,String> tags)

The collection of tags. Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

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

createdDate

CreateStageResponse.Builder createdDate(Instant 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

CreateStageResponse.Builder lastUpdatedDate(Instant 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.