Class CreateBasePathMappingRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Requests Amazon API Gateway to create a new BasePathMapping resource.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The base path name that callers of the API must provide as part of the URL after the domain name.The domain name of the BasePathMapping resource to create.The name of the API that you want to apply this mapping to.getStage()
The name of the API's stage that you want to use for this mapping.int
hashCode()
void
setBasePath
(String basePath) The base path name that callers of the API must provide as part of the URL after the domain name.void
setDomainName
(String domainName) The domain name of the BasePathMapping resource to create.void
setRestApiId
(String restApiId) The name of the API that you want to apply this mapping to.void
The name of the API's stage that you want to use for this mapping.toString()
Returns a string representation of this object; useful for testing and debugging.withBasePath
(String basePath) The base path name that callers of the API must provide as part of the URL after the domain name.withDomainName
(String domainName) The domain name of the BasePathMapping resource to create.withRestApiId
(String restApiId) The name of the API that you want to apply this mapping to.The name of the API's stage that you want to use for this mapping.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateBasePathMappingRequest
public CreateBasePathMappingRequest()
-
-
Method Details
-
setDomainName
The domain name of the BasePathMapping resource to create.
- Parameters:
domainName
- The domain name of the BasePathMapping resource to create.
-
getDomainName
The domain name of the BasePathMapping resource to create.
- Returns:
- The domain name of the BasePathMapping resource to create.
-
withDomainName
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.
-
setBasePath
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.
-
getBasePath
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.
-
withBasePath
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.
-
setRestApiId
The name of the API that you want to apply this mapping to.
- Parameters:
restApiId
- The name of the API that you want to apply this mapping to.
-
getRestApiId
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.
-
withRestApiId
The name of the API that you want to apply this mapping to.
- Parameters:
restApiId
- The name of the API that you want to apply this mapping to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStage
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.
-
getStage
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.
-
withStage
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-