Package software.amazon.awssdk.services.apigateway.model

Class CreateBasePathMappingRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateBasePathMappingRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>

Requests Amazon API Gateway to create a new BasePathMapping resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBasePathMappingRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	basePath()	The base path name that callers of the API must provide as part of the URL after the domain name.
static CreateBasePathMappingRequest.Builder	builder()
String	domainName()	The domain name of the BasePathMapping resource to create.
boolean	equals(Object obj)
int	hashCode()
String	restApiId()	The name of the API that you want to apply this mapping to.
static Class<? extends CreateBasePathMappingRequest.Builder>	serializableBuilderClass()
String	stage()	The name of the API's stage that you want to use for this mapping.
CreateBasePathMappingRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

domainName

public String domainName()

The domain name of the BasePathMapping resource to create.

Returns:

The domain name of the BasePathMapping resource to create.

basePath

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

Returns:

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.

restApiId

public String restApiId()

The name of the API that you want to apply this mapping to.

Returns:

The name of the API that you want to apply this mapping to.

stage

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

Returns:

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.

toBuilder

public CreateBasePathMappingRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>

Returns:

a builder for type T

builder

public static CreateBasePathMappingRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBasePathMappingRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object