Class UpdateStageResult

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

public class UpdateStageResult extends Object implements Serializable, Cloneable

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

See Also:
  • Constructor Details

    • UpdateStageResult

      public UpdateStageResult()
  • Method Details

    • setDeploymentId

      public void setDeploymentId(String deploymentId)

      The identifier of the Deployment that the stage points to.

      Parameters:
      deploymentId - The identifier of the Deployment that the stage points to.
    • getDeploymentId

      public String getDeploymentId()

      The identifier of the Deployment that the stage points to.

      Returns:
      The identifier of the Deployment that the stage points to.
    • withDeploymentId

      public UpdateStageResult withDeploymentId(String deploymentId)

      The identifier of the Deployment that the stage points to.

      Parameters:
      deploymentId - The identifier of the Deployment that the stage points to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setClientCertificateId

      public void setClientCertificateId(String clientCertificateId)
      Parameters:
      clientCertificateId -
    • getClientCertificateId

      public String getClientCertificateId()
      Returns:
    • withClientCertificateId

      public UpdateStageResult withClientCertificateId(String clientCertificateId)
      Parameters:
      clientCertificateId -
      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 is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

      Parameters:
      stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
    • getStageName

      public String getStageName()

      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

      Returns:
      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
    • withStageName

      public UpdateStageResult withStageName(String stageName)

      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

      Parameters:
      stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDescription

      public void setDescription(String description)

      The stage's description.

      Parameters:
      description - The stage's description.
    • getDescription

      public String getDescription()

      The stage's description.

      Returns:
      The stage's description.
    • withDescription

      public UpdateStageResult withDescription(String description)

      The stage's description.

      Parameters:
      description - The stage's description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCacheClusterEnabled

      public void setCacheClusterEnabled(Boolean cacheClusterEnabled)

      Specifies whether a cache cluster is enabled for the stage.

      Parameters:
      cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.
    • getCacheClusterEnabled

      public Boolean getCacheClusterEnabled()

      Specifies whether a cache cluster is enabled for the stage.

      Returns:
      Specifies whether a cache cluster is enabled for the stage.
    • withCacheClusterEnabled

      public UpdateStageResult withCacheClusterEnabled(Boolean cacheClusterEnabled)

      Specifies whether a cache cluster is enabled for the stage.

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

      public Boolean isCacheClusterEnabled()

      Specifies whether a cache cluster is enabled for the stage.

      Returns:
      Specifies whether a cache cluster is enabled for the stage.
    • setCacheClusterSize

      public void setCacheClusterSize(String cacheClusterSize)

      The size of the cache cluster for the stage, if enabled.

      Parameters:
      cacheClusterSize - The size of the cache cluster for the stage, if enabled.
    • getCacheClusterSize

      public String getCacheClusterSize()

      The size of the cache cluster for the stage, if enabled.

      Returns:
      The size of the cache cluster for the stage, if enabled.
    • withCacheClusterSize

      public UpdateStageResult withCacheClusterSize(String cacheClusterSize)

      The size of the cache cluster for the stage, if enabled.

      Parameters:
      cacheClusterSize - The size of the cache cluster for the stage, if enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCacheClusterStatus

      public void setCacheClusterStatus(String cacheClusterStatus)

      The status of the cache cluster for the stage, if enabled.

      Parameters:
      cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
      See Also:
    • getCacheClusterStatus

      public String getCacheClusterStatus()

      The status of the cache cluster for the stage, if enabled.

      Returns:
      The status of the cache cluster for the stage, if enabled.
      See Also:
    • withCacheClusterStatus

      public UpdateStageResult withCacheClusterStatus(String cacheClusterStatus)

      The status of the cache cluster for the stage, if enabled.

      Parameters:
      cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setCacheClusterStatus

      public void setCacheClusterStatus(CacheClusterStatus cacheClusterStatus)

      The status of the cache cluster for the stage, if enabled.

      Parameters:
      cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
      See Also:
    • withCacheClusterStatus

      public UpdateStageResult withCacheClusterStatus(CacheClusterStatus cacheClusterStatus)

      The status of the cache cluster for the stage, if enabled.

      Parameters:
      cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • getMethodSettings

      public Map<String,MethodSetting> getMethodSettings()

      A map that defines the method settings for a Stage resource. Keys are defined as {resource_path}/{http_method} for an individual method override, or \*/\* for the settings applied to all methods in the stage.

      Returns:
      A map that defines the method settings for a Stage resource. Keys are defined as {resource_path}/{http_method} for an individual method override, or \*/\* for the settings applied to all methods in the stage.
    • setMethodSettings

      public void setMethodSettings(Map<String,MethodSetting> methodSettings)

      A map that defines the method settings for a Stage resource. Keys are defined as {resource_path}/{http_method} for an individual method override, or \*/\* for the settings applied to all methods in the stage.

      Parameters:
      methodSettings - A map that defines the method settings for a Stage resource. Keys are defined as {resource_path}/{http_method} for an individual method override, or \*/\* for the settings applied to all methods in the stage.
    • withMethodSettings

      public UpdateStageResult withMethodSettings(Map<String,MethodSetting> methodSettings)

      A map that defines the method settings for a Stage resource. Keys are defined as {resource_path}/{http_method} for an individual method override, or \*/\* for the settings applied to all methods in the stage.

      Parameters:
      methodSettings - A map that defines the method settings for a Stage resource. Keys are defined as {resource_path}/{http_method} for an individual method override, or \*/\* for the settings applied to all methods in the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • addMethodSettingsEntry

      public UpdateStageResult addMethodSettingsEntry(String key, MethodSetting value)
    • clearMethodSettingsEntries

      public UpdateStageResult clearMethodSettingsEntries()
      Removes all the entries added into MethodSettings. <p> 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 a 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 a 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 a 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 a Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    • withVariables

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

      A map that defines the stage variables for a 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 a 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 UpdateStageResult addVariablesEntry(String key, String value)
    • clearVariablesEntries

      public UpdateStageResult clearVariablesEntries()
      Removes all the entries added into Variables. <p> Returns a reference to this object so that method calls can be chained together.
    • setCreatedDate

      public void setCreatedDate(Date createdDate)

      The date and time that the stage was created, in ISO 8601 format.

      Parameters:
      createdDate - The date and time that the stage was created, in ISO 8601 format.
    • getCreatedDate

      public Date getCreatedDate()

      The date and time that the stage was created, in ISO 8601 format.

      Returns:
      The date and time that the stage was created, in ISO 8601 format.
    • withCreatedDate

      public UpdateStageResult withCreatedDate(Date createdDate)

      The date and time that the stage was created, in ISO 8601 format.

      Parameters:
      createdDate - The date and time that the stage was created, in ISO 8601 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLastUpdatedDate

      public void setLastUpdatedDate(Date lastUpdatedDate)

      The date and time that information about the stage was last updated, in ISO 8601 format.

      Parameters:
      lastUpdatedDate - The date and time that information about the stage was last updated, in ISO 8601 format.
    • getLastUpdatedDate

      public Date getLastUpdatedDate()

      The date and time that information about the stage was last updated, in ISO 8601 format.

      Returns:
      The date and time that information about the stage was last updated, in ISO 8601 format.
    • withLastUpdatedDate

      public UpdateStageResult withLastUpdatedDate(Date lastUpdatedDate)

      The date and time that information about the stage was last updated, in ISO 8601 format.

      Parameters:
      lastUpdatedDate - The date and time that information about the stage was last updated, in ISO 8601 format.
      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

      public UpdateStageResult clone()
      Overrides:
      clone in class Object