Interface UpdateStageResponse.Builder
- All Superinterfaces:
ApiGatewayV2Response.Builder
,AwsResponse.Builder
,Buildable
,CopyableBuilder<UpdateStageResponse.Builder,
,UpdateStageResponse> SdkBuilder<UpdateStageResponse.Builder,
,UpdateStageResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
UpdateStageResponse
-
Method Summary
Modifier and TypeMethodDescriptiondefault UpdateStageResponse.Builder
accessLogSettings
(Consumer<AccessLogSettings.Builder> accessLogSettings) Settings for logging access in this stage.accessLogSettings
(AccessLogSettings accessLogSettings) Settings for logging access in this stage.apiGatewayManaged
(Boolean apiGatewayManaged) Specifies whether a stage is managed by API Gateway.autoDeploy
(Boolean autoDeploy) Specifies whether updates to an API automatically trigger a new deployment.clientCertificateId
(String clientCertificateId) The identifier of a client certificate for a Stage.createdDate
(Instant createdDate) The timestamp when the stage was created.default UpdateStageResponse.Builder
defaultRouteSettings
(Consumer<RouteSettings.Builder> defaultRouteSettings) Default route settings for the stage.defaultRouteSettings
(RouteSettings defaultRouteSettings) Default route settings for the stage.deploymentId
(String deploymentId) The identifier of the Deployment that the Stage is associated with.description
(String description) The description of the stage.lastDeploymentStatusMessage
(String lastDeploymentStatusMessage) Describes the status of the last deployment of a stage.lastUpdatedDate
(Instant lastUpdatedDate) The timestamp when the stage was last updated.routeSettings
(Map<String, RouteSettings> routeSettings) Route settings for the stage, by routeKey.The name of the stage.stageVariables
(Map<String, String> stageVariables) A map that defines the stage variables for a stage resource.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.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, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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 UpdateStageResponse.Builder accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings) Settings for logging access in this stage.
This is a convenience method that creates an instance of theAccessLogSettings.Builder
avoiding the need to create one manually viaAccessLogSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaccessLogSettings(AccessLogSettings)
.- Parameters:
accessLogSettings
- a consumer that will call methods onAccessLogSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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 UpdateStageResponse.Builder defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings) Default route settings for the stage.
This is a convenience method that creates an instance of theRouteSettings.Builder
avoiding the need to create one manually viaRouteSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultRouteSettings(RouteSettings)
.- Parameters:
defaultRouteSettings
- a consumer that will call methods onRouteSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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
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
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.
-