Package software.amazon.awssdk.services.securityhub.model

Interface AwsApiGatewayStageDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsApiGatewayStageDetails.Builder,AwsApiGatewayStageDetails>, SdkBuilder<AwsApiGatewayStageDetails.Builder,AwsApiGatewayStageDetails>, SdkPojo

Enclosing class:

AwsApiGatewayStageDetails

public static interface AwsApiGatewayStageDetails.Builder
extends SdkPojo, CopyableBuilder<AwsApiGatewayStageDetails.Builder,AwsApiGatewayStageDetails>

Method Summary

Modifier and Type	Method	Description
default AwsApiGatewayStageDetails.Builder	accessLogSettings(Consumer<AwsApiGatewayAccessLogSettings.Builder> accessLogSettings)	Settings for logging access for the stage.
AwsApiGatewayStageDetails.Builder	accessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)	Settings for logging access for the stage.
AwsApiGatewayStageDetails.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled)	Indicates whether a cache cluster is enabled for the stage.
AwsApiGatewayStageDetails.Builder	cacheClusterSize(String cacheClusterSize)	If a cache cluster is enabled, the size of the cache cluster.
AwsApiGatewayStageDetails.Builder	cacheClusterStatus(String cacheClusterStatus)	If a cache cluster is enabled, the status of the cache cluster.
default AwsApiGatewayStageDetails.Builder	canarySettings(Consumer<AwsApiGatewayCanarySettings.Builder> canarySettings)	Information about settings for canary deployment in the stage.
AwsApiGatewayStageDetails.Builder	canarySettings(AwsApiGatewayCanarySettings canarySettings)	Information about settings for canary deployment in the stage.
AwsApiGatewayStageDetails.Builder	clientCertificateId(String clientCertificateId)	The identifier of the client certificate for the stage.
AwsApiGatewayStageDetails.Builder	createdDate(String createdDate)	Indicates when the stage was created.
AwsApiGatewayStageDetails.Builder	deploymentId(String deploymentId)	The identifier of the deployment that the stage points to.
AwsApiGatewayStageDetails.Builder	description(String description)	A description of the stage.
AwsApiGatewayStageDetails.Builder	documentationVersion(String documentationVersion)	The version of the API documentation that is associated with the stage.
AwsApiGatewayStageDetails.Builder	lastUpdatedDate(String lastUpdatedDate)	Indicates when the stage was most recently updated.
AwsApiGatewayStageDetails.Builder	methodSettings(Collection<AwsApiGatewayMethodSettings> methodSettings)	Defines the method settings for the stage.
AwsApiGatewayStageDetails.Builder	methodSettings(Consumer<AwsApiGatewayMethodSettings.Builder>... methodSettings)	Defines the method settings for the stage.
AwsApiGatewayStageDetails.Builder	methodSettings(AwsApiGatewayMethodSettings... methodSettings)	Defines the method settings for the stage.
AwsApiGatewayStageDetails.Builder	stageName(String stageName)	The name of the stage.
AwsApiGatewayStageDetails.Builder	tracingEnabled(Boolean tracingEnabled)	Indicates whether active tracing with X-Ray is enabled for the stage.
AwsApiGatewayStageDetails.Builder	variables(Map<String,String> variables)	A map that defines the stage variables for the stage.
AwsApiGatewayStageDetails.Builder	webAclArn(String webAclArn)	The ARN of the web ACL associated with the stage.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

deploymentId

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

AwsApiGatewayStageDetails.Builder clientCertificateId(String clientCertificateId)

The identifier of the client certificate for the stage.

Parameters:

clientCertificateId - The identifier of the client certificate for the stage.

Returns:

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

stageName

AwsApiGatewayStageDetails.Builder stageName(String stageName)

The name of the stage.

Parameters:

stageName - The name of the stage.

Returns:

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

description

AwsApiGatewayStageDetails.Builder description(String description)

A description of the stage.

Parameters:

description - A description of the stage.

Returns:

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

cacheClusterEnabled

AwsApiGatewayStageDetails.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Indicates whether a cache cluster is enabled for the stage.

Parameters:

cacheClusterEnabled - Indicates 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

AwsApiGatewayStageDetails.Builder cacheClusterSize(String cacheClusterSize)

If a cache cluster is enabled, the size of the cache cluster.

Parameters:

cacheClusterSize - If a cache cluster is enabled, the size of the cache cluster.

Returns:

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

cacheClusterStatus

AwsApiGatewayStageDetails.Builder cacheClusterStatus(String cacheClusterStatus)

If a cache cluster is enabled, the status of the cache cluster.

Parameters:

cacheClusterStatus - If a cache cluster is enabled, the status of the cache cluster.

Returns:

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

methodSettings

AwsApiGatewayStageDetails.Builder methodSettings(Collection<AwsApiGatewayMethodSettings> methodSettings)

Defines the method settings for the stage.

Parameters:

methodSettings - Defines the method settings for the stage.

Returns:

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

methodSettings

AwsApiGatewayStageDetails.Builder methodSettings(AwsApiGatewayMethodSettings... methodSettings)

Defines the method settings for the stage.

Parameters:

methodSettings - Defines the method settings for the stage.

Returns:

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

methodSettings

AwsApiGatewayStageDetails.Builder methodSettings(Consumer<AwsApiGatewayMethodSettings.Builder>... methodSettings)

Defines the method settings for the stage.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #methodSettings(List).

Parameters:

methodSettings - a consumer that will call methods on AwsApiGatewayMethodSettings.Builder

Returns:

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

See Also:

#methodSettings(java.util.Collection)

variables

AwsApiGatewayStageDetails.Builder variables(Map<String,String> variables)

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

• Uppercase and lowercase letters

• Numbers

• Special characters -._~:/?#&=,

Parameters:

variables - A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

• Uppercase and lowercase letters

• Numbers

• Special characters -._~:/?#&=,

Returns:

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

documentationVersion

AwsApiGatewayStageDetails.Builder documentationVersion(String documentationVersion)

The version of the API documentation that is associated with the stage.

Parameters:

documentationVersion - The version of the API documentation that is associated with the stage.

Returns:

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

accessLogSettings

AwsApiGatewayStageDetails.Builder accessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)

Settings for logging access for the stage.

Parameters:

accessLogSettings - Settings for logging access for the stage.

Returns:

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

accessLogSettings

default AwsApiGatewayStageDetails.Builder accessLogSettings(Consumer<AwsApiGatewayAccessLogSettings.Builder> accessLogSettings)

Settings for logging access for the stage.

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

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

Parameters:

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

Returns:

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

See Also:

accessLogSettings(AwsApiGatewayAccessLogSettings)

canarySettings

AwsApiGatewayStageDetails.Builder canarySettings(AwsApiGatewayCanarySettings canarySettings)

Information about settings for canary deployment in the stage.

Parameters:

canarySettings - Information about settings for canary deployment in the stage.

Returns:

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

canarySettings

default AwsApiGatewayStageDetails.Builder canarySettings(Consumer<AwsApiGatewayCanarySettings.Builder> canarySettings)

Information about settings for canary deployment in the stage.

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

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

Parameters:

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

Returns:

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

See Also:

canarySettings(AwsApiGatewayCanarySettings)

tracingEnabled

AwsApiGatewayStageDetails.Builder tracingEnabled(Boolean tracingEnabled)

Indicates whether active tracing with X-Ray is enabled for the stage.

Parameters:

tracingEnabled - Indicates 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.

createdDate

AwsApiGatewayStageDetails.Builder createdDate(String createdDate)

Indicates when the stage was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Parameters:

createdDate - Indicates when the stage was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Returns:

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

lastUpdatedDate

AwsApiGatewayStageDetails.Builder lastUpdatedDate(String lastUpdatedDate)

Indicates when the stage was most recently updated.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Parameters:

lastUpdatedDate - Indicates when the stage was most recently updated.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Returns:

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

webAclArn

AwsApiGatewayStageDetails.Builder webAclArn(String webAclArn)

The ARN of the web ACL associated with the stage.

Parameters:

webAclArn - The ARN of the web ACL associated with the stage.

Returns:

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