Stage (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.Stage

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Stage
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Stage()

Constructors
Constructor and Description
`Stage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Stage`	`addMethodSettingsEntry(String key, MethodSetting value)`
`Stage`	`addVariablesEntry(String key, String value)`
`Stage`	`clearMethodSettingsEntries()` Removes all the entries added into MethodSettings.
`Stage`	`clearVariablesEntries()` Removes all the entries added into Variables.
`Stage`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCacheClusterEnabled()` Specifies whether a cache cluster is enabled for the stage.
`String`	`getCacheClusterSize()` The size of the cache cluster for the stage, if enabled.
`String`	`getCacheClusterStatus()` The status of the cache cluster for the stage, if enabled.
`String`	`getClientCertificateId()` The identifier of a client certificate for an API stage.
`Date`	`getCreatedDate()` The timestamp when the stage was created.
`String`	`getDeploymentId()` The identifier of the Deployment that the stage points to.
`String`	`getDescription()` The stage's description.
`String`	`getDocumentationVersion()` The version of the associated API documentation.
`Date`	`getLastUpdatedDate()` The timestamp when the stage last updated.
`Map<String,MethodSetting>`	`getMethodSettings()` A map that defines the method settings for a Stage resource.
`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.
`Map<String,String>`	`getVariables()` A map that defines the stage variables for a Stage resource.
`int`	`hashCode()`
`Boolean`	`isCacheClusterEnabled()` Specifies whether a cache cluster is enabled for the stage.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCacheClusterEnabled(Boolean cacheClusterEnabled)` Specifies whether a cache cluster is enabled for the stage.
`void`	`setCacheClusterSize(String cacheClusterSize)` The size of the cache cluster for the stage, if enabled.
`void`	`setCacheClusterStatus(CacheClusterStatus cacheClusterStatus)` The status of the cache cluster for the stage, if enabled.
`void`	`setCacheClusterStatus(String cacheClusterStatus)` The status of the cache cluster for the stage, if enabled.
`void`	`setClientCertificateId(String clientCertificateId)` The identifier of a client certificate for an API stage.
`void`	`setCreatedDate(Date createdDate)` The timestamp when the stage was created.
`void`	`setDeploymentId(String deploymentId)` The identifier of the Deployment that the stage points to.
`void`	`setDescription(String description)` The stage's description.
`void`	`setDocumentationVersion(String documentationVersion)` The version of the associated API documentation.
`void`	`setLastUpdatedDate(Date lastUpdatedDate)` The timestamp when the stage last updated.
`void`	`setMethodSettings(Map<String,MethodSetting> methodSettings)` A map that defines the method settings for a Stage resource.
`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.
`void`	`setVariables(Map<String,String> variables)` A map that defines the stage variables for a Stage resource.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Stage`	`withCacheClusterEnabled(Boolean cacheClusterEnabled)` Specifies whether a cache cluster is enabled for the stage.
`Stage`	`withCacheClusterSize(String cacheClusterSize)` The size of the cache cluster for the stage, if enabled.
`Stage`	`withCacheClusterStatus(CacheClusterStatus cacheClusterStatus)` The status of the cache cluster for the stage, if enabled.
`Stage`	`withCacheClusterStatus(String cacheClusterStatus)` The status of the cache cluster for the stage, if enabled.
`Stage`	`withClientCertificateId(String clientCertificateId)` The identifier of a client certificate for an API stage.
`Stage`	`withCreatedDate(Date createdDate)` The timestamp when the stage was created.
`Stage`	`withDeploymentId(String deploymentId)` The identifier of the Deployment that the stage points to.
`Stage`	`withDescription(String description)` The stage's description.
`Stage`	`withDocumentationVersion(String documentationVersion)` The version of the associated API documentation.
`Stage`	`withLastUpdatedDate(Date lastUpdatedDate)` The timestamp when the stage last updated.
`Stage`	`withMethodSettings(Map<String,MethodSetting> methodSettings)` A map that defines the method settings for a Stage resource.
`Stage`	`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.
`Stage`	`withVariables(Map<String,String> variables)` A map that defines the stage variables for a Stage resource.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Stage
```
public Stage()
```
- Method Detail
  - 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 Stage 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)
```
    The identifier of a client certificate for an API stage.
    
    Parameters:
    
    clientCertificateId - The identifier of a client certificate for an API stage.
  - getClientCertificateId
```
public String getClientCertificateId()
```
    The identifier of a client certificate for an API stage.
    
    Returns:
    
    The identifier of a client certificate for an API stage.
  - withClientCertificateId
```
public Stage withClientCertificateId(String clientCertificateId)
```
    The identifier of a client certificate for an API stage.
    
    Parameters:
    
    clientCertificateId - The identifier of a client certificate for an API stage.
    
    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 Stage 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 Stage 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 Stage 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 Stage 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:
    
    CacheClusterStatus
  - 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:
    
    CacheClusterStatus
  - withCacheClusterStatus
```
public Stage 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:
    
    CacheClusterStatus
  - 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:
    
    CacheClusterStatus
  - withCacheClusterStatus
```
public Stage 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:
    
    CacheClusterStatus
  - getMethodSettings
```
public Map<String,MethodSetting> getMethodSettings()
```
    A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    
    Returns:
    
    A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding 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 (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    
    Parameters:
    
    methodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
  - withMethodSettings
```
public Stage withMethodSettings(Map<String,MethodSetting> methodSettings)
```
    A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    
    Parameters:
    
    methodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMethodSettingsEntry
```
public Stage addMethodSettingsEntry(String key,
                                    MethodSetting value)
```
  - clearMethodSettingsEntries
```
public Stage clearMethodSettingsEntries()
```
    Removes all the entries added into MethodSettings.
    
    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 a Stage resource. Variable names can have alphanumeric and underscore 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 and underscore 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 and underscore 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 and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
  - withVariables
```
public Stage withVariables(Map<String,String> variables)
```
    A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore 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 and underscore 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 Stage addVariablesEntry(String key,
                               String value)
```
  - clearVariablesEntries
```
public Stage clearVariablesEntries()
```
    Removes all the entries added into Variables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentationVersion
```
public void setDocumentationVersion(String documentationVersion)
```
    The version of the associated API documentation.
    
    Parameters:
    
    documentationVersion - The version of the associated API documentation.
  - getDocumentationVersion
```
public String getDocumentationVersion()
```
    The version of the associated API documentation.
    
    Returns:
    
    The version of the associated API documentation.
  - withDocumentationVersion
```
public Stage withDocumentationVersion(String documentationVersion)
```
    The version of the associated API documentation.
    
    Parameters:
    
    documentationVersion - The version of the associated API documentation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The timestamp when the stage was created.
    
    Parameters:
    
    createdDate - The timestamp when the stage was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The timestamp when the stage was created.
    
    Returns:
    
    The timestamp when the stage was created.
  - withCreatedDate
```
public Stage withCreatedDate(Date createdDate)
```
    The timestamp when the stage was created.
    
    Parameters:
    
    createdDate - The timestamp when the stage was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDate
```
public void setLastUpdatedDate(Date lastUpdatedDate)
```
    The timestamp when the stage last updated.
    
    Parameters:
    
    lastUpdatedDate - The timestamp when the stage last updated.
  - getLastUpdatedDate
```
public Date getLastUpdatedDate()
```
    The timestamp when the stage last updated.
    
    Returns:
    
    The timestamp when the stage last updated.
  - withLastUpdatedDate
```
public Stage withLastUpdatedDate(Date lastUpdatedDate)
```
    The timestamp when the stage last updated.
    
    Parameters:
    
    lastUpdatedDate - The timestamp when the stage last updated.
    
    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:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Stage clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Stage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Stage

Method Detail

setDeploymentId

getDeploymentId

withDeploymentId

setClientCertificateId

getClientCertificateId

withClientCertificateId

setStageName

getStageName

withStageName

setDescription

getDescription

withDescription

setCacheClusterEnabled

getCacheClusterEnabled

withCacheClusterEnabled

isCacheClusterEnabled

setCacheClusterSize

getCacheClusterSize

withCacheClusterSize

setCacheClusterStatus

getCacheClusterStatus

withCacheClusterStatus

setCacheClusterStatus

withCacheClusterStatus

getMethodSettings

setMethodSettings

withMethodSettings

addMethodSettingsEntry

clearMethodSettingsEntries

getVariables

setVariables

withVariables

addVariablesEntry

clearVariablesEntries

setDocumentationVersion

getDocumentationVersion

withDocumentationVersion

setCreatedDate

getCreatedDate

withCreatedDate

setLastUpdatedDate

getLastUpdatedDate

withLastUpdatedDate

toString

equals

hashCode

clone

marshall