software.amazon.awssdk.services.apigateway.model

Interface CreateBasePathMappingRequest.Builder

All Superinterfaces:

APIGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>, SdkBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>, SdkRequest.Builder

Enclosing class:

CreateBasePathMappingRequest

public static interface CreateBasePathMappingRequest.Builder
extends APIGatewayRequest.Builder, CopyableBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>

Method Summary

Modifier and Type	Method and Description
CreateBasePathMappingRequest.Builder	basePath(String basePath) The base path name that callers of the API must provide as part of the URL after the domain name.
CreateBasePathMappingRequest.Builder	domainName(String domainName) The domain name of the BasePathMapping resource to create.
CreateBasePathMappingRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CreateBasePathMappingRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
CreateBasePathMappingRequest.Builder	restApiId(String restApiId) The string identifier of the associated RestApi.
CreateBasePathMappingRequest.Builder	stage(String stage) The name of the API's stage that you want to use for this mapping.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.APIGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

domainName

CreateBasePathMappingRequest.Builder domainName(String domainName)

The domain name of the BasePathMapping resource to create.

Parameters:

domainName - The domain name of the BasePathMapping resource to create.

Returns:

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

basePath

CreateBasePathMappingRequest.Builder basePath(String basePath)

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.

Parameters:

basePath - The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.

Returns:

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

restApiId

CreateBasePathMappingRequest.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

stage

CreateBasePathMappingRequest.Builder stage(String stage)

The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.

Parameters:

stage - The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.

Returns:

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

requestOverrideConfig

CreateBasePathMappingRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CreateBasePathMappingRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.