Class CreateStageRequest

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

public class CreateStageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Requests Amazon API Gateway to create a Stage resource.

See Also:
  • Constructor Details

    • CreateStageRequest

      public CreateStageRequest()
  • Method Details

    • setRestApiId

      public void setRestApiId(String restApiId)

      The identifier of the RestApi resource for the Stage resource to create.

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

      public String getRestApiId()

      The identifier of the RestApi resource for the Stage resource to create.

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

      public CreateStageRequest withRestApiId(String restApiId)

      The identifier of the RestApi resource for the Stage resource to create.

      Parameters:
      restApiId - The identifier of the RestApi resource for the Stage 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 for the Stage resource.

      Parameters:
      stageName - The name for the Stage resource.
    • getStageName

      public String getStageName()

      The name for the Stage resource.

      Returns:
      The name for the Stage resource.
    • withStageName

      public CreateStageRequest withStageName(String stageName)

      The name for the Stage resource.

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

      public void setDeploymentId(String deploymentId)

      The identifier of the Deployment resource for the Stage resource.

      Parameters:
      deploymentId - The identifier of the Deployment resource for the Stage resource.
    • getDeploymentId

      public String getDeploymentId()

      The identifier of the Deployment resource for the Stage resource.

      Returns:
      The identifier of the Deployment resource for the Stage resource.
    • withDeploymentId

      public CreateStageRequest withDeploymentId(String deploymentId)

      The identifier of the Deployment resource for the Stage resource.

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

      public void setDescription(String description)

      The description of the Stage resource.

      Parameters:
      description - The description of the Stage resource.
    • getDescription

      public String getDescription()

      The description of the Stage resource.

      Returns:
      The description of the Stage resource.
    • withDescription

      public CreateStageRequest withDescription(String description)

      The description of the Stage resource.

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

      public void setCacheClusterEnabled(Boolean cacheClusterEnabled)

      Whether cache clustering is enabled for the stage.

      Parameters:
      cacheClusterEnabled - Whether cache clustering is enabled for the stage.
    • getCacheClusterEnabled

      public Boolean getCacheClusterEnabled()

      Whether cache clustering is enabled for the stage.

      Returns:
      Whether cache clustering is enabled for the stage.
    • withCacheClusterEnabled

      public CreateStageRequest withCacheClusterEnabled(Boolean cacheClusterEnabled)

      Whether cache clustering is enabled for the stage.

      Parameters:
      cacheClusterEnabled - Whether cache clustering is enabled for the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isCacheClusterEnabled

      public Boolean isCacheClusterEnabled()

      Whether cache clustering is enabled for the stage.

      Returns:
      Whether cache clustering is enabled for the stage.
    • setCacheClusterSize

      public void setCacheClusterSize(String cacheClusterSize)

      The stage's cache cluster size.

      Parameters:
      cacheClusterSize - The stage's cache cluster size.
    • getCacheClusterSize

      public String getCacheClusterSize()

      The stage's cache cluster size.

      Returns:
      The stage's cache cluster size.
    • withCacheClusterSize

      public CreateStageRequest withCacheClusterSize(String cacheClusterSize)

      The stage's cache cluster size.

      Parameters:
      cacheClusterSize - The stage's cache cluster size.
      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 new Stage resource. 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 new Stage resource. 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 new Stage resource. 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 new Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    • withVariables

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

      A map that defines the stage variables for the new Stage resource. 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 new Stage resource. 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 CreateStageRequest addVariablesEntry(String key, String value)
    • clearVariablesEntries

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