Interface CreateStageRequest.Builder
-
- All Superinterfaces:
ApiGatewayV2Request.Builder,AwsRequest.Builder,Buildable,CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>,SdkBuilder<CreateStageRequest.Builder,CreateStageRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateStageRequest
public static interface CreateStageRequest.Builder extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreateStageRequest.BuilderaccessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)Settings for logging access in this stage.CreateStageRequest.BuilderaccessLogSettings(AccessLogSettings accessLogSettings)Settings for logging access in this stage.CreateStageRequest.BuilderapiId(String apiId)The API identifier.CreateStageRequest.BuilderautoDeploy(Boolean autoDeploy)Specifies whether updates to an API automatically trigger a new deployment.CreateStageRequest.BuilderclientCertificateId(String clientCertificateId)The identifier of a client certificate for a Stage.default CreateStageRequest.BuilderdefaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings)The default route settings for the stage.CreateStageRequest.BuilderdefaultRouteSettings(RouteSettings defaultRouteSettings)The default route settings for the stage.CreateStageRequest.BuilderdeploymentId(String deploymentId)The deployment identifier of the API stage.CreateStageRequest.Builderdescription(String description)The description for the API stage.CreateStageRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateStageRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateStageRequest.BuilderrouteSettings(Map<String,RouteSettings> routeSettings)Route settings for the stage, by routeKey.CreateStageRequest.BuilderstageName(String stageName)The name of the stage.CreateStageRequest.BuilderstageVariables(Map<String,String> stageVariables)A map that defines the stage variables for a Stage.CreateStageRequest.Buildertags(Map<String,String> tags)The collection of tags.-
Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
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
-
-
-
-
Method Detail
-
accessLogSettings
CreateStageRequest.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 CreateStageRequest.Builder accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)
Settings for logging access in this stage.
This is a convenience method that creates an instance of theAccessLogSettings.Builderavoiding the need to create one manually viaAccessLogSettings.builder().When the
Consumercompletes,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:
accessLogSettings(AccessLogSettings)
-
apiId
CreateStageRequest.Builder apiId(String apiId)
The API identifier.
- Parameters:
apiId- The API identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoDeploy
CreateStageRequest.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
CreateStageRequest.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.
-
defaultRouteSettings
CreateStageRequest.Builder defaultRouteSettings(RouteSettings defaultRouteSettings)
The default route settings for the stage.
- Parameters:
defaultRouteSettings- The default route settings for the stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultRouteSettings
default CreateStageRequest.Builder defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings)
The default route settings for the stage.
This is a convenience method that creates an instance of theRouteSettings.Builderavoiding the need to create one manually viaRouteSettings.builder().When the
Consumercompletes,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:
defaultRouteSettings(RouteSettings)
-
deploymentId
CreateStageRequest.Builder deploymentId(String deploymentId)
The deployment identifier of the API stage.
- Parameters:
deploymentId- The deployment identifier of the API stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
CreateStageRequest.Builder description(String description)
The description for the API stage.
- Parameters:
description- The description for the API stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
routeSettings
CreateStageRequest.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
CreateStageRequest.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
CreateStageRequest.Builder stageVariables(Map<String,String> stageVariables)
A map that defines the stage variables for a Stage. 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. 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
CreateStageRequest.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.
-
overrideConfiguration
CreateStageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateStageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-