Class CreateBasePathMappingRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.apigateway.model.CreateBasePathMappingRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class CreateBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Requests Amazon API Gateway to create a new BasePathMapping resource.

See Also:
  • Constructor Details

    • CreateBasePathMappingRequest

      public CreateBasePathMappingRequest()
  • Method Details

    • setDomainName

      public void setDomainName(String domainName)

      The domain name of the BasePathMapping resource to create.

      Parameters:
      domainName - The domain name of the BasePathMapping resource to create.
    • getDomainName

      public String getDomainName()

      The domain name of the BasePathMapping resource to create.

      Returns:
      The domain name of the BasePathMapping resource to create.
    • withDomainName

      public CreateBasePathMappingRequest withDomainName(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.
    • setBasePath

      public void setBasePath(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.
    • getBasePath

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

      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

      public CreateBasePathMappingRequest withBasePath(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.
    • setRestApiId

      public void setRestApiId(String restApiId)

      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

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

      public CreateBasePathMappingRequest withRestApiId(String restApiId)

      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

      public void setStage(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.
    • getStage

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

      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

      public CreateBasePathMappingRequest withStage(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.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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 class AmazonWebServiceRequest
      See Also: