software.amazon.awssdk.services.apigatewayv2.model

Interface GetStageResponse.Builder

All Superinterfaces:

ApiGatewayV2Response.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<GetStageResponse.Builder,GetStageResponse>, SdkBuilder<GetStageResponse.Builder,GetStageResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetStageResponse

public static interface GetStageResponse.Builder
extends ApiGatewayV2Response.Builder, SdkPojo, CopyableBuilder<GetStageResponse.Builder,GetStageResponse>

Method Summary

Modifier and Type	Method and Description
GetStageResponse.Builder	accessLogSettings(AccessLogSettings accessLogSettings) Settings for logging access in this stage.
default GetStageResponse.Builder	accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings) Settings for logging access in this stage.
GetStageResponse.Builder	apiGatewayManaged(Boolean apiGatewayManaged) Specifies whether a stage is managed by API Gateway.
GetStageResponse.Builder	autoDeploy(Boolean autoDeploy) Specifies whether updates to an API automatically trigger a new deployment.
GetStageResponse.Builder	clientCertificateId(String clientCertificateId) The identifier of a client certificate for a Stage.
GetStageResponse.Builder	createdDate(Instant createdDate) The timestamp when the stage was created.
default GetStageResponse.Builder	defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings) Default route settings for the stage.
GetStageResponse.Builder	defaultRouteSettings(RouteSettings defaultRouteSettings) Default route settings for the stage.
GetStageResponse.Builder	deploymentId(String deploymentId) The identifier of the Deployment that the Stage is associated with.
GetStageResponse.Builder	description(String description) The description of the stage.
GetStageResponse.Builder	lastDeploymentStatusMessage(String lastDeploymentStatusMessage) Describes the status of the last deployment of a stage.
GetStageResponse.Builder	lastUpdatedDate(Instant lastUpdatedDate) The timestamp when the stage was last updated.
GetStageResponse.Builder	routeSettings(Map<String,RouteSettings> routeSettings) Route settings for the stage, by routeKey.
GetStageResponse.Builder	stageName(String stageName) The name of the stage.
GetStageResponse.Builder	stageVariables(Map<String,String> stageVariables) A map that defines the stage variables for a stage resource.
GetStageResponse.Builder	tags(Map<String,String> tags) The collection of tags.

Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response.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

accessLogSettings

GetStageResponse.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 GetStageResponse.Builder accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)

Settings for logging access in this stage.

This is a convenience 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)

apiGatewayManaged

GetStageResponse.Builder apiGatewayManaged(Boolean apiGatewayManaged)

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Parameters:

apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Returns:

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

autoDeploy

GetStageResponse.Builder autoDeploy(Boolean autoDeploy)

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Parameters:

autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

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

clientCertificateId

GetStageResponse.Builder clientCertificateId(String clientCertificateId)

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Parameters:

clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Returns:

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

createdDate

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

defaultRouteSettings

GetStageResponse.Builder defaultRouteSettings(RouteSettings 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 GetStageResponse.Builder defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings)

Default route settings for the stage.

This is a convenience that creates an instance of the RouteSettings.Builder avoiding the need to create one manually via RouteSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultRouteSettings(RouteSettings).

Parameters:

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

Returns:

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

See Also:

defaultRouteSettings(RouteSettings)

deploymentId

GetStageResponse.Builder deploymentId(String deploymentId)

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Parameters:

deploymentId - The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Returns:

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

description

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

lastDeploymentStatusMessage

GetStageResponse.Builder lastDeploymentStatusMessage(String lastDeploymentStatusMessage)

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Parameters:

lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Returns:

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

lastUpdatedDate

GetStageResponse.Builder lastUpdatedDate(Instant lastUpdatedDate)

The timestamp when the stage was last updated.

Parameters:

lastUpdatedDate - The timestamp when the stage was last updated.

Returns:

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

routeSettings

GetStageResponse.Builder routeSettings(Map<String,RouteSettings> routeSettings)

Route settings for the stage, by routeKey.

Parameters:

routeSettings - Route settings for the stage, by routeKey.

Returns:

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

stageName

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

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

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:

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

tags

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