Class GetStageResult
- All Implemented Interfaces:
Serializable
,Cloneable
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddMethodSettingsEntry
(String key, MethodSetting value) addVariablesEntry
(String key, String value) Removes all the entries added into MethodSettings.Removes all the entries added into Variables.clone()
boolean
Specifies whether a cache cluster is enabled for the stage.The size of the cache cluster for the stage, if enabled.The status of the cache cluster for the stage, if enabled.The date and time that the stage was created, in ISO 8601 format.The identifier of the Deployment that the stage points to.The stage's description.The date and time that information about the stage was last updated, in ISO 8601 format.A map that defines the method settings for a Stage resource.The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.A map that defines the stage variables for a Stage resource.int
hashCode()
Specifies whether a cache cluster is enabled for the stage.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) void
setCreatedDate
(Date createdDate) The date and time that the stage was created, in ISO 8601 format.void
setDeploymentId
(String deploymentId) The identifier of the Deployment that the stage points to.void
setDescription
(String description) The stage's description.void
setLastUpdatedDate
(Date lastUpdatedDate) The date and time that information about the stage was last updated, in ISO 8601 format.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.toString()
Returns a string representation of this object; useful for testing and debugging.withCacheClusterEnabled
(Boolean cacheClusterEnabled) Specifies whether a cache cluster is enabled for the stage.withCacheClusterSize
(String cacheClusterSize) The size of the cache cluster for the stage, if enabled.withCacheClusterStatus
(CacheClusterStatus cacheClusterStatus) The status of the cache cluster for the stage, if enabled.withCacheClusterStatus
(String cacheClusterStatus) The status of the cache cluster for the stage, if enabled.withClientCertificateId
(String clientCertificateId) withCreatedDate
(Date createdDate) The date and time that the stage was created, in ISO 8601 format.withDeploymentId
(String deploymentId) The identifier of the Deployment that the stage points to.withDescription
(String description) The stage's description.withLastUpdatedDate
(Date lastUpdatedDate) The date and time that information about the stage was last updated, in ISO 8601 format.withMethodSettings
(Map<String, MethodSetting> methodSettings) A map that defines the method settings for a Stage resource.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.withVariables
(Map<String, String> variables) A map that defines the stage variables for a Stage resource.
-
Constructor Details
-
GetStageResult
public GetStageResult()
-
-
Method Details
-
setDeploymentId
The identifier of the Deployment that the stage points to.
- Parameters:
deploymentId
- The identifier of the Deployment that the stage points to.
-
getDeploymentId
The identifier of the Deployment that the stage points to.
- Returns:
- The identifier of the Deployment that the stage points to.
-
withDeploymentId
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
- Parameters:
clientCertificateId
-
-
getClientCertificateId
- Returns:
-
withClientCertificateId
- Parameters:
clientCertificateId
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStageName
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
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
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
The stage's description.
- Parameters:
description
- The stage's description.
-
getDescription
The stage's description.
- Returns:
- The stage's description.
-
withDescription
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
Specifies whether a cache cluster is enabled for the stage.
- Parameters:
cacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage.
-
getCacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
- Returns:
- Specifies whether a cache cluster is enabled for the stage.
-
withCacheClusterEnabled
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
Specifies whether a cache cluster is enabled for the stage.
- Returns:
- Specifies whether a cache cluster is enabled for the stage.
-
setCacheClusterSize
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
The size of the cache cluster for the stage, if enabled.
- Returns:
- The size of the cache cluster for the stage, if enabled.
-
withCacheClusterSize
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
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
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
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
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
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
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
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
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
-
clearMethodSettingsEntries
Removes all the entries added into MethodSettings. <p> Returns a reference to this object so that method calls can be chained together. -
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
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
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
-
clearVariablesEntries
Removes all the entries added into Variables. <p> Returns a reference to this object so that method calls can be chained together. -
setCreatedDate
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-