Package software.amazon.awssdk.services.apigatewayv2.model

Interface UpdateStageRequest.Builder

All Superinterfaces:

ApiGatewayV2Request.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<UpdateStageRequest.Builder,UpdateStageRequest>, SdkBuilder<UpdateStageRequest.Builder,UpdateStageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateStageRequest

public static interface UpdateStageRequest.Builder
extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<UpdateStageRequest.Builder,UpdateStageRequest>

Method Summary

Modifier and Type	Method	Description
default UpdateStageRequest.Builder	accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)	Settings for logging access in this stage.
UpdateStageRequest.Builder	accessLogSettings(AccessLogSettings accessLogSettings)	Settings for logging access in this stage.
UpdateStageRequest.Builder	apiId(String apiId)	The API identifier.
UpdateStageRequest.Builder	autoDeploy(Boolean autoDeploy)	Specifies whether updates to an API automatically trigger a new deployment.
UpdateStageRequest.Builder	clientCertificateId(String clientCertificateId)	The identifier of a client certificate for a Stage.
default UpdateStageRequest.Builder	defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings)	The default route settings for the stage.
UpdateStageRequest.Builder	defaultRouteSettings(RouteSettings defaultRouteSettings)	The default route settings for the stage.
UpdateStageRequest.Builder	deploymentId(String deploymentId)	The deployment identifier for the API stage.
UpdateStageRequest.Builder	description(String description)	The description for the API stage.
UpdateStageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateStageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateStageRequest.Builder	routeSettings(Map<String,RouteSettings> routeSettings)	Route settings for the stage.
UpdateStageRequest.Builder	stageName(String stageName)	The stage name.
UpdateStageRequest.Builder	stageVariables(Map<String,String> stageVariables)	A map that defines the stage variables for a Stage.

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, sdkFieldNameToField, sdkFields

Method Detail

accessLogSettings

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

Settings for logging access in this stage.

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

apiId

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

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

UpdateStageRequest.Builder clientCertificateId(String clientCertificateId)

The identifier of a client certificate for a Stage.

Parameters:

clientCertificateId - The identifier of a client certificate for a Stage.

Returns:

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

defaultRouteSettings

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

The default route settings for the stage.

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

UpdateStageRequest.Builder deploymentId(String deploymentId)

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Parameters:

deploymentId - The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Returns:

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

description

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

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

Route settings for the stage.

Parameters:

routeSettings - Route settings for the stage.

Returns:

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

stageName

UpdateStageRequest.Builder stageName(String stageName)

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Parameters:

stageName - The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Returns:

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

stageVariables

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

overrideConfiguration

UpdateStageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateStageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder