software.amazon.awssdk.services.securityhub.model

Interface AwsApiGatewayV2StageDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsApiGatewayV2StageDetails

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

Method Summary

Modifier and Type	Method and Description
AwsApiGatewayV2StageDetails.Builder	accessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings) Information about settings for logging access for the stage.
default AwsApiGatewayV2StageDetails.Builder	accessLogSettings(Consumer<AwsApiGatewayAccessLogSettings.Builder> accessLogSettings) Information about settings for logging access for the stage.
AwsApiGatewayV2StageDetails.Builder	apiGatewayManaged(Boolean apiGatewayManaged) Indicates whether the stage is managed by API Gateway.
AwsApiGatewayV2StageDetails.Builder	autoDeploy(Boolean autoDeploy) Indicates whether updates to an API automatically trigger a new deployment.
AwsApiGatewayV2StageDetails.Builder	clientCertificateId(String clientCertificateId) The identifier of a client certificate for a stage.
AwsApiGatewayV2StageDetails.Builder	createdDate(String createdDate) Indicates when the stage was created.
AwsApiGatewayV2StageDetails.Builder	defaultRouteSettings(AwsApiGatewayV2RouteSettings defaultRouteSettings) Default route settings for the stage.
default AwsApiGatewayV2StageDetails.Builder	defaultRouteSettings(Consumer<AwsApiGatewayV2RouteSettings.Builder> defaultRouteSettings) Default route settings for the stage.
AwsApiGatewayV2StageDetails.Builder	deploymentId(String deploymentId) The identifier of the deployment that the stage is associated with.
AwsApiGatewayV2StageDetails.Builder	description(String description) The description of the stage.
AwsApiGatewayV2StageDetails.Builder	lastDeploymentStatusMessage(String lastDeploymentStatusMessage) The status of the last deployment of a stage.
AwsApiGatewayV2StageDetails.Builder	lastUpdatedDate(String lastUpdatedDate) Indicates when the stage was most recently updated.
AwsApiGatewayV2StageDetails.Builder	routeSettings(AwsApiGatewayV2RouteSettings routeSettings) The route settings for the stage.
default AwsApiGatewayV2StageDetails.Builder	routeSettings(Consumer<AwsApiGatewayV2RouteSettings.Builder> routeSettings) The route settings for the stage.
AwsApiGatewayV2StageDetails.Builder	stageName(String stageName) The name of the stage.
AwsApiGatewayV2StageDetails.Builder	stageVariables(Map<String,String> stageVariables) A map that defines the stage variables for the stage.

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

clientCertificateId

AwsApiGatewayV2StageDetails.Builder clientCertificateId(String clientCertificateId)

The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

Parameters:

clientCertificateId - The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

Returns:

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

createdDate

AwsApiGatewayV2StageDetails.Builder createdDate(String createdDate)

Indicates when the stage was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Parameters:

createdDate - Indicates when the stage was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Returns:

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

description

AwsApiGatewayV2StageDetails.Builder description(String description)

The description of the stage.

Parameters:

description - The description of the stage.

Returns:

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

defaultRouteSettings

AwsApiGatewayV2StageDetails.Builder defaultRouteSettings(AwsApiGatewayV2RouteSettings defaultRouteSettings)

Default route settings for the stage.

Parameters:

defaultRouteSettings - Default route settings for the stage.

Returns:

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

defaultRouteSettings

default AwsApiGatewayV2StageDetails.Builder defaultRouteSettings(Consumer<AwsApiGatewayV2RouteSettings.Builder> defaultRouteSettings)

Default route settings for the stage.

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

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

Parameters:

defaultRouteSettings - a consumer that will call methods on AwsApiGatewayV2RouteSettings.Builder

Returns:

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

See Also:

defaultRouteSettings(AwsApiGatewayV2RouteSettings)

deploymentId

AwsApiGatewayV2StageDetails.Builder deploymentId(String deploymentId)

The identifier of the deployment that the stage is associated with.

Parameters:

deploymentId - The identifier of the deployment that the stage is associated with.

Returns:

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

lastUpdatedDate

AwsApiGatewayV2StageDetails.Builder lastUpdatedDate(String lastUpdatedDate)

Indicates when the stage was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Parameters:

lastUpdatedDate - Indicates when the stage was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Returns:

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

routeSettings

AwsApiGatewayV2StageDetails.Builder routeSettings(AwsApiGatewayV2RouteSettings routeSettings)

The route settings for the stage.

Parameters:

routeSettings - The route settings for the stage.

Returns:

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

routeSettings

default AwsApiGatewayV2StageDetails.Builder routeSettings(Consumer<AwsApiGatewayV2RouteSettings.Builder> routeSettings)

The route settings for the stage.

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

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

Parameters:

routeSettings - a consumer that will call methods on AwsApiGatewayV2RouteSettings.Builder

Returns:

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

See Also:

routeSettings(AwsApiGatewayV2RouteSettings)

stageName

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

stageVariables

AwsApiGatewayV2StageDetails.Builder stageVariables(Map<String,String> stageVariables)

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:

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

accessLogSettings

AwsApiGatewayV2StageDetails.Builder accessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)

Information about settings for logging access for the stage.

Parameters:

accessLogSettings - Information about settings for logging access for the stage.

Returns:

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

accessLogSettings

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

Information about 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)

autoDeploy

AwsApiGatewayV2StageDetails.Builder autoDeploy(Boolean autoDeploy)

Indicates whether updates to an API automatically trigger a new deployment.

Parameters:

autoDeploy - Indicates whether updates to an API automatically trigger a new deployment.

Returns:

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

lastDeploymentStatusMessage

AwsApiGatewayV2StageDetails.Builder lastDeploymentStatusMessage(String lastDeploymentStatusMessage)

The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

Parameters:

lastDeploymentStatusMessage - The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

Returns:

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

apiGatewayManaged

AwsApiGatewayV2StageDetails.Builder apiGatewayManaged(Boolean apiGatewayManaged)

Indicates whether the stage is managed by API Gateway.

Parameters:

apiGatewayManaged - Indicates whether the stage is managed by API Gateway.

Returns:

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