public class CreateBasePathMappingRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Requests Amazon API Gateway to create a new BasePathMapping resource.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
basePath
The base path name that callers of the API must provide as part of the
URL after the domain name.
|
private java.lang.String |
domainName
The domain name of the BasePathMapping resource to create.
|
private java.lang.String |
restApiId
The name of the API that you want to apply this mapping to.
|
private java.lang.String |
stage
The name of the API's stage that you want to use for this mapping.
|
NOOP
Constructor and Description |
---|
CreateBasePathMappingRequest() |
Modifier and Type | Method and Description |
---|---|
CreateBasePathMappingRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getBasePath()
The base path name that callers of the API must provide as part of the
URL after the domain name.
|
java.lang.String |
getDomainName()
The domain name of the BasePathMapping resource to create.
|
java.lang.String |
getRestApiId()
The name of the API that you want to apply this mapping to.
|
java.lang.String |
getStage()
The name of the API's stage that you want to use for this mapping.
|
int |
hashCode() |
void |
setBasePath(java.lang.String basePath)
The base path name that callers of the API must provide as part of the
URL after the domain name.
|
void |
setDomainName(java.lang.String domainName)
The domain name of the BasePathMapping resource to create.
|
void |
setRestApiId(java.lang.String restApiId)
The name of the API that you want to apply this mapping to.
|
void |
setStage(java.lang.String stage)
The name of the API's stage that you want to use for this mapping.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateBasePathMappingRequest |
withBasePath(java.lang.String basePath)
The base path name that callers of the API must provide as part of the
URL after the domain name.
|
CreateBasePathMappingRequest |
withDomainName(java.lang.String domainName)
The domain name of the BasePathMapping resource to create.
|
CreateBasePathMappingRequest |
withRestApiId(java.lang.String restApiId)
The name of the API that you want to apply this mapping to.
|
CreateBasePathMappingRequest |
withStage(java.lang.String stage)
The name of the API's stage that you want to use for this mapping.
|
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
private java.lang.String domainName
The domain name of the BasePathMapping resource to create.
private java.lang.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.
private java.lang.String restApiId
The name of the API that you want to apply this mapping to.
private java.lang.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.
public void setDomainName(java.lang.String domainName)
The domain name of the BasePathMapping resource to create.
domainName
- The domain name of the BasePathMapping resource to create.public java.lang.String getDomainName()
The domain name of the BasePathMapping resource to create.
public CreateBasePathMappingRequest withDomainName(java.lang.String domainName)
The domain name of the BasePathMapping resource to create.
domainName
- The domain name of the BasePathMapping resource to create.public void setBasePath(java.lang.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.
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.public java.lang.String 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.
public CreateBasePathMappingRequest withBasePath(java.lang.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.
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.public void setRestApiId(java.lang.String restApiId)
The name of the API that you want to apply this mapping to.
restApiId
- The name of the API that you want to apply this mapping to.public java.lang.String getRestApiId()
The name of the API that you want to apply this mapping to.
public CreateBasePathMappingRequest withRestApiId(java.lang.String restApiId)
The name of the API that you want to apply this mapping to.
restApiId
- The name of the API that you want to apply this mapping to.public void setStage(java.lang.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.
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.public java.lang.String 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.
public CreateBasePathMappingRequest withStage(java.lang.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateBasePathMappingRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()