Interface CreateBasePathMappingRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateBasePathMappingRequest.Builder,
,CreateBasePathMappingRequest> SdkBuilder<CreateBasePathMappingRequest.Builder,
,CreateBasePathMappingRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateBasePathMappingRequest
public static interface CreateBasePathMappingRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>
-
Method Summary
Modifier and TypeMethodDescriptionThe base path name that callers of the API must provide as part of the URL after the domain name.domainName
(String domainName) The domain name of the BasePathMapping resource to create.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The string identifier of the associated RestApi.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
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 Details
-
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
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. Specify '(none)' 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. Specify '(none)' 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
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
The name of the API's stage that you want to use for this mapping. Specify '(none)' if you 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. Specify '(none)' if you 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.
-
overrideConfiguration
CreateBasePathMappingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateBasePathMappingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-