Class CreateDeploymentRequest

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

public class CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Requests Amazon API Gateway to create a Deployment resource.

See Also:
  • Constructor Details

    • CreateDeploymentRequest

      public CreateDeploymentRequest()
  • Method Details

    • setRestApiId

      public void setRestApiId(String restApiId)

      The RestApi resource identifier for the Deployment resource to create.

      Parameters:
      restApiId - The RestApi resource identifier for the Deployment resource to create.
    • getRestApiId

      public String getRestApiId()

      The RestApi resource identifier for the Deployment resource to create.

      Returns:
      The RestApi resource identifier for the Deployment resource to create.
    • withRestApiId

      public CreateDeploymentRequest withRestApiId(String restApiId)

      The RestApi resource identifier for the Deployment resource to create.

      Parameters:
      restApiId - The RestApi resource identifier for the Deployment resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStageName

      public void setStageName(String stageName)

      The name of the Stage resource for the Deployment resource to create.

      Parameters:
      stageName - The name of the Stage resource for the Deployment resource to create.
    • getStageName

      public String getStageName()

      The name of the Stage resource for the Deployment resource to create.

      Returns:
      The name of the Stage resource for the Deployment resource to create.
    • withStageName

      public CreateDeploymentRequest withStageName(String stageName)

      The name of the Stage resource for the Deployment resource to create.

      Parameters:
      stageName - The name of the Stage resource for the Deployment resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStageDescription

      public void setStageDescription(String stageDescription)

      The description of the Stage resource for the Deployment resource to create.

      Parameters:
      stageDescription - The description of the Stage resource for the Deployment resource to create.
    • getStageDescription

      public String getStageDescription()

      The description of the Stage resource for the Deployment resource to create.

      Returns:
      The description of the Stage resource for the Deployment resource to create.
    • withStageDescription

      public CreateDeploymentRequest withStageDescription(String stageDescription)

      The description of the Stage resource for the Deployment resource to create.

      Parameters:
      stageDescription - The description of the Stage resource for the Deployment resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDescription

      public void setDescription(String description)

      The description for the Deployment resource to create.

      Parameters:
      description - The description for the Deployment resource to create.
    • getDescription

      public String getDescription()

      The description for the Deployment resource to create.

      Returns:
      The description for the Deployment resource to create.
    • withDescription

      public CreateDeploymentRequest withDescription(String description)

      The description for the Deployment resource to create.

      Parameters:
      description - The description for the Deployment resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCacheClusterEnabled

      public void setCacheClusterEnabled(Boolean cacheClusterEnabled)

      Enables a cache cluster for the Stage resource specified in the input.

      Parameters:
      cacheClusterEnabled - Enables a cache cluster for the Stage resource specified in the input.
    • getCacheClusterEnabled

      public Boolean getCacheClusterEnabled()

      Enables a cache cluster for the Stage resource specified in the input.

      Returns:
      Enables a cache cluster for the Stage resource specified in the input.
    • withCacheClusterEnabled

      public CreateDeploymentRequest withCacheClusterEnabled(Boolean cacheClusterEnabled)

      Enables a cache cluster for the Stage resource specified in the input.

      Parameters:
      cacheClusterEnabled - Enables a cache cluster for the Stage resource specified in the input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isCacheClusterEnabled

      public Boolean isCacheClusterEnabled()

      Enables a cache cluster for the Stage resource specified in the input.

      Returns:
      Enables a cache cluster for the Stage resource specified in the input.
    • setCacheClusterSize

      public void setCacheClusterSize(String cacheClusterSize)

      Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

      Parameters:
      cacheClusterSize - Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
    • getCacheClusterSize

      public String getCacheClusterSize()

      Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

      Returns:
      Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
    • withCacheClusterSize

      public CreateDeploymentRequest withCacheClusterSize(String cacheClusterSize)

      Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

      Parameters:
      cacheClusterSize - Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getVariables

      public Map<String,String> getVariables()

      A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      Returns:
      A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    • setVariables

      public void setVariables(Map<String,String> variables)

      A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      Parameters:
      variables - A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    • withVariables

      public CreateDeploymentRequest withVariables(Map<String,String> variables)

      A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      Parameters:
      variables - A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • addVariablesEntry

      public CreateDeploymentRequest addVariablesEntry(String key, String value)
    • clearVariablesEntries

      public CreateDeploymentRequest clearVariablesEntries()
      Removes all the entries added into Variables. <p> 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

      public CreateDeploymentRequest 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: