software.amazon.awssdk.services.apigatewayv2.model

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

Modifier and Type	Method and Description
CreateStageRequest.Builder	accessLogSettings(AccessLogSettings accessLogSettings) Settings for logging access in this stage.
default CreateStageRequest.Builder	accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings) Settings for logging access in this stage.
CreateStageRequest.Builder	apiId(String apiId) The API identifier.
CreateStageRequest.Builder	clientCertificateId(String clientCertificateId) The identifier of a client certificate for a Stage.
default CreateStageRequest.Builder	defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings) The default route settings for the stage.
CreateStageRequest.Builder	defaultRouteSettings(RouteSettings defaultRouteSettings) The default route settings for the stage.
CreateStageRequest.Builder	deploymentId(String deploymentId) The deployment identifier of the API stage.
CreateStageRequest.Builder	description(String description) The description for the API stage.
CreateStageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateStageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateStageRequest.Builder	routeSettings(Map<String,RouteSettings> routeSettings) Route settings for the stage.
CreateStageRequest.Builder	stageName(String stageName) The name of the stage.
CreateStageRequest.Builder	stageVariables(Map<String,String> stageVariables) A map that defines the stage variables for a Stage.
CreateStageRequest.Builder	tags(Map<String,String> tags) The key-value map of strings.

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

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

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.

clientCertificateId

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

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

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.

Parameters:

routeSettings - Route settings for the stage.

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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

Parameters:

tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

Returns:

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

overrideConfiguration

CreateStageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder