public static interface UpdateStageResponse.Builder extends ApiGatewayV2Response.Builder, SdkPojo, CopyableBuilder<UpdateStageResponse.Builder,UpdateStageResponse>
Modifier and Type | Method and Description |
---|---|
UpdateStageResponse.Builder |
accessLogSettings(AccessLogSettings accessLogSettings)
Settings for logging access in this stage.
|
default UpdateStageResponse.Builder |
accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)
Settings for logging access in this stage.
|
UpdateStageResponse.Builder |
apiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether a stage is managed by API Gateway.
|
UpdateStageResponse.Builder |
autoDeploy(Boolean autoDeploy)
Specifies whether updates to an API automatically trigger a new deployment.
|
UpdateStageResponse.Builder |
clientCertificateId(String clientCertificateId)
The identifier of a client certificate for a Stage.
|
UpdateStageResponse.Builder |
createdDate(Instant createdDate)
The timestamp when the stage was created.
|
default UpdateStageResponse.Builder |
defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings)
Default route settings for the stage.
|
UpdateStageResponse.Builder |
defaultRouteSettings(RouteSettings defaultRouteSettings)
Default route settings for the stage.
|
UpdateStageResponse.Builder |
deploymentId(String deploymentId)
The identifier of the Deployment that the Stage is associated with.
|
UpdateStageResponse.Builder |
description(String description)
The description of the stage.
|
UpdateStageResponse.Builder |
lastDeploymentStatusMessage(String lastDeploymentStatusMessage)
Describes the status of the last deployment of a stage.
|
UpdateStageResponse.Builder |
lastUpdatedDate(Instant lastUpdatedDate)
The timestamp when the stage was last updated.
|
UpdateStageResponse.Builder |
routeSettings(Map<String,RouteSettings> routeSettings)
Route settings for the stage, by routeKey.
|
UpdateStageResponse.Builder |
stageName(String stageName)
The name of the stage.
|
UpdateStageResponse.Builder |
stageVariables(Map<String,String> stageVariables)
A map that defines the stage variables for a stage resource.
|
UpdateStageResponse.Builder |
tags(Map<String,String> tags)
The collection of tags.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
UpdateStageResponse.Builder accessLogSettings(AccessLogSettings accessLogSettings)
Settings for logging access in this stage.
accessLogSettings
- Settings for logging access in this stage.default UpdateStageResponse.Builder accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)
Settings for logging access in this stage.
This is a convenience that creates an instance of theAccessLogSettings.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)
.accessLogSettings
- a consumer that will call methods on AccessLogSettings.Builder
accessLogSettings(AccessLogSettings)
UpdateStageResponse.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.
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.UpdateStageResponse.Builder autoDeploy(Boolean autoDeploy)
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
autoDeploy
- Specifies whether updates to an API automatically trigger a new deployment. The default value is
false.UpdateStageResponse.Builder clientCertificateId(String clientCertificateId)
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
clientCertificateId
- The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.UpdateStageResponse.Builder createdDate(Instant createdDate)
The timestamp when the stage was created.
createdDate
- The timestamp when the stage was created.UpdateStageResponse.Builder defaultRouteSettings(RouteSettings defaultRouteSettings)
Default route settings for the stage.
defaultRouteSettings
- Default route settings for the stage.default UpdateStageResponse.Builder defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings)
Default route settings for the stage.
This is a convenience that creates an instance of theRouteSettings.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)
.defaultRouteSettings
- a consumer that will call methods on RouteSettings.Builder
defaultRouteSettings(RouteSettings)
UpdateStageResponse.Builder deploymentId(String deploymentId)
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
deploymentId
- The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is
enabled.UpdateStageResponse.Builder description(String description)
The description of the stage.
description
- The description of the stage.UpdateStageResponse.Builder lastDeploymentStatusMessage(String lastDeploymentStatusMessage)
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
lastDeploymentStatusMessage
- Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy
enabled.UpdateStageResponse.Builder lastUpdatedDate(Instant lastUpdatedDate)
The timestamp when the stage was last updated.
lastUpdatedDate
- The timestamp when the stage was last updated.UpdateStageResponse.Builder routeSettings(Map<String,RouteSettings> routeSettings)
Route settings for the stage, by routeKey.
routeSettings
- Route settings for the stage, by routeKey.UpdateStageResponse.Builder stageName(String stageName)
The name of the stage.
stageName
- The name of the stage.UpdateStageResponse.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-._~:/?#&=,]+.
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-._~:/?#&=,]+.UpdateStageResponse.Builder tags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.