@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Constructor and Description |
---|
UpdateStageResult() |
Modifier and Type | Method and Description |
---|---|
UpdateStageResult |
addMethodSettingsEntry(String key,
MethodSetting value)
Add a single MethodSettings entry
|
UpdateStageResult |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
UpdateStageResult |
addVariablesEntry(String key,
String value)
Add a single Variables entry
|
UpdateStageResult |
clearMethodSettingsEntries()
Removes all the entries added into MethodSettings.
|
UpdateStageResult |
clearTagsEntries()
Removes all the entries added into Tags.
|
UpdateStageResult |
clearVariablesEntries()
Removes all the entries added into Variables.
|
UpdateStageResult |
clone() |
boolean |
equals(Object obj) |
AccessLogSettings |
getAccessLogSettings()
Settings for logging access in this stage.
|
Boolean |
getCacheClusterEnabled()
Specifies whether a cache cluster is enabled for the stage.
|
String |
getCacheClusterSize()
The stage's cache capacity in GB.
|
String |
getCacheClusterStatus()
The status of the cache cluster for the stage, if enabled.
|
CanarySettings |
getCanarySettings()
Settings for the canary deployment in this stage.
|
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 API
Gateway.
|
Map<String,String> |
getTags()
The collection of tags.
|
Boolean |
getTracingEnabled()
Specifies whether active tracing with X-ray is enabled for the Stage.
|
Map<String,String> |
getVariables()
A map that defines the stage variables for a Stage resource.
|
String |
getWebAclArn()
The ARN of the WebAcl associated with the Stage.
|
int |
hashCode() |
Boolean |
isCacheClusterEnabled()
Specifies whether a cache cluster is enabled for the stage.
|
Boolean |
isTracingEnabled()
Specifies whether active tracing with X-ray is enabled for the Stage.
|
void |
setAccessLogSettings(AccessLogSettings accessLogSettings)
Settings for logging access in this stage.
|
void |
setCacheClusterEnabled(Boolean cacheClusterEnabled)
Specifies whether a cache cluster is enabled for the stage.
|
void |
setCacheClusterSize(String cacheClusterSize)
The stage's cache capacity in GB.
|
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 |
setCanarySettings(CanarySettings canarySettings)
Settings for the canary deployment in this stage.
|
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 API
Gateway.
|
void |
setTags(Map<String,String> tags)
The collection of tags.
|
void |
setTracingEnabled(Boolean tracingEnabled)
Specifies whether active tracing with X-ray is enabled for the Stage.
|
void |
setVariables(Map<String,String> variables)
A map that defines the stage variables for a Stage resource.
|
void |
setWebAclArn(String webAclArn)
The ARN of the WebAcl associated with the Stage.
|
String |
toString()
Returns a string representation of this object.
|
UpdateStageResult |
withAccessLogSettings(AccessLogSettings accessLogSettings)
Settings for logging access in this stage.
|
UpdateStageResult |
withCacheClusterEnabled(Boolean cacheClusterEnabled)
Specifies whether a cache cluster is enabled for the stage.
|
UpdateStageResult |
withCacheClusterSize(String cacheClusterSize)
The stage's cache capacity in GB.
|
UpdateStageResult |
withCacheClusterStatus(CacheClusterStatus cacheClusterStatus)
The status of the cache cluster for the stage, if enabled.
|
UpdateStageResult |
withCacheClusterStatus(String cacheClusterStatus)
The status of the cache cluster for the stage, if enabled.
|
UpdateStageResult |
withCanarySettings(CanarySettings canarySettings)
Settings for the canary deployment in this stage.
|
UpdateStageResult |
withClientCertificateId(String clientCertificateId)
The identifier of a client certificate for an API stage.
|
UpdateStageResult |
withCreatedDate(Date createdDate)
The timestamp when the stage was created.
|
UpdateStageResult |
withDeploymentId(String deploymentId)
The identifier of the Deployment that the stage points to.
|
UpdateStageResult |
withDescription(String description)
The stage's description.
|
UpdateStageResult |
withDocumentationVersion(String documentationVersion)
The version of the associated API documentation.
|
UpdateStageResult |
withLastUpdatedDate(Date lastUpdatedDate)
The timestamp when the stage last updated.
|
UpdateStageResult |
withMethodSettings(Map<String,MethodSetting> methodSettings)
A map that defines the method settings for a Stage resource.
|
UpdateStageResult |
withStageName(String stageName)
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API
Gateway.
|
UpdateStageResult |
withTags(Map<String,String> tags)
The collection of tags.
|
UpdateStageResult |
withTracingEnabled(Boolean tracingEnabled)
Specifies whether active tracing with X-ray is enabled for the Stage.
|
UpdateStageResult |
withVariables(Map<String,String> variables)
A map that defines the stage variables for a Stage resource.
|
UpdateStageResult |
withWebAclArn(String webAclArn)
The ARN of the WebAcl associated with the Stage.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setDeploymentId(String deploymentId)
The identifier of the Deployment that the stage points to.
deploymentId
- The identifier of the Deployment that the stage points to.public String getDeploymentId()
The identifier of the Deployment that the stage points to.
public UpdateStageResult withDeploymentId(String deploymentId)
The identifier of the Deployment that the stage points to.
deploymentId
- The identifier of the Deployment that the stage points to.public void setClientCertificateId(String clientCertificateId)
The identifier of a client certificate for an API stage.
clientCertificateId
- The identifier of a client certificate for an API stage.public String getClientCertificateId()
The identifier of a client certificate for an API stage.
public UpdateStageResult withClientCertificateId(String clientCertificateId)
The identifier of a client certificate for an API stage.
clientCertificateId
- The identifier of a client certificate for an API stage.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 API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
stageName
- The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API
Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is
128 characters.public String getStageName()
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
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 API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
stageName
- The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API
Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is
128 characters.public void setDescription(String description)
The stage's description.
description
- The stage's description.public String getDescription()
The stage's description.
public UpdateStageResult withDescription(String description)
The stage's description.
description
- The stage's description.public void setCacheClusterEnabled(Boolean cacheClusterEnabled)
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
to true
for a method.
cacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
to true
for a method.public Boolean getCacheClusterEnabled()
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
to true
for a method.
CachingEnabled
to true
for a method.public UpdateStageResult withCacheClusterEnabled(Boolean cacheClusterEnabled)
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
to true
for a method.
cacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
to true
for a method.public Boolean isCacheClusterEnabled()
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
to true
for a method.
CachingEnabled
to true
for a method.public void setCacheClusterSize(String cacheClusterSize)
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
cacheClusterSize
- The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API
caching to enhance responsiveness.public String getCacheClusterSize()
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
public UpdateStageResult withCacheClusterSize(String cacheClusterSize)
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
cacheClusterSize
- The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API
caching to enhance responsiveness.public void setCacheClusterStatus(String cacheClusterStatus)
The status of the cache cluster for the stage, if enabled.
cacheClusterStatus
- The status of the cache cluster for the stage, if enabled.CacheClusterStatus
public String getCacheClusterStatus()
The status of the cache cluster for the stage, if enabled.
CacheClusterStatus
public UpdateStageResult withCacheClusterStatus(String cacheClusterStatus)
The status of the cache cluster for the stage, if enabled.
cacheClusterStatus
- The status of the cache cluster for the stage, if enabled.CacheClusterStatus
public void setCacheClusterStatus(CacheClusterStatus cacheClusterStatus)
The status of the cache cluster for the stage, if enabled.
cacheClusterStatus
- The status of the cache cluster for the stage, if enabled.CacheClusterStatus
public UpdateStageResult withCacheClusterStatus(CacheClusterStatus cacheClusterStatus)
The status of the cache cluster for the stage, if enabled.
cacheClusterStatus
- The status of the cache cluster for the stage, if enabled.CacheClusterStatus
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.
/{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.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.
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.public UpdateStageResult 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.
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.public UpdateStageResult addMethodSettingsEntry(String key, MethodSetting value)
public UpdateStageResult clearMethodSettingsEntries()
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-._~:/?#&=,]+
.
[A-Za-z0-9-._~:/?#&=,]+
.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-._~:/?#&=,]+
.
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-._~:/?#&=,]+
.public UpdateStageResult 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-._~:/?#&=,]+
.
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-._~:/?#&=,]+
.public UpdateStageResult addVariablesEntry(String key, String value)
public UpdateStageResult clearVariablesEntries()
public void setDocumentationVersion(String documentationVersion)
The version of the associated API documentation.
documentationVersion
- The version of the associated API documentation.public String getDocumentationVersion()
The version of the associated API documentation.
public UpdateStageResult withDocumentationVersion(String documentationVersion)
The version of the associated API documentation.
documentationVersion
- The version of the associated API documentation.public void setAccessLogSettings(AccessLogSettings accessLogSettings)
Settings for logging access in this stage.
accessLogSettings
- Settings for logging access in this stage.public AccessLogSettings getAccessLogSettings()
Settings for logging access in this stage.
public UpdateStageResult withAccessLogSettings(AccessLogSettings accessLogSettings)
Settings for logging access in this stage.
accessLogSettings
- Settings for logging access in this stage.public void setCanarySettings(CanarySettings canarySettings)
Settings for the canary deployment in this stage.
canarySettings
- Settings for the canary deployment in this stage.public CanarySettings getCanarySettings()
Settings for the canary deployment in this stage.
public UpdateStageResult withCanarySettings(CanarySettings canarySettings)
Settings for the canary deployment in this stage.
canarySettings
- Settings for the canary deployment in this stage.public void setTracingEnabled(Boolean tracingEnabled)
Specifies whether active tracing with X-ray is enabled for the Stage.
tracingEnabled
- Specifies whether active tracing with X-ray is enabled for the Stage.public Boolean getTracingEnabled()
Specifies whether active tracing with X-ray is enabled for the Stage.
public UpdateStageResult withTracingEnabled(Boolean tracingEnabled)
Specifies whether active tracing with X-ray is enabled for the Stage.
tracingEnabled
- Specifies whether active tracing with X-ray is enabled for the Stage.public Boolean isTracingEnabled()
Specifies whether active tracing with X-ray is enabled for the Stage.
public void setWebAclArn(String webAclArn)
The ARN of the WebAcl associated with the Stage.
webAclArn
- The ARN of the WebAcl associated with the Stage.public String getWebAclArn()
The ARN of the WebAcl associated with the Stage.
public UpdateStageResult withWebAclArn(String webAclArn)
The ARN of the WebAcl associated with the Stage.
webAclArn
- The ARN of the WebAcl associated with the Stage.public Map<String,String> getTags()
The collection of tags. Each tag element is associated with a given resource.
public void setTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public UpdateStageResult withTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public UpdateStageResult addTagsEntry(String key, String value)
public UpdateStageResult clearTagsEntries()
public void setCreatedDate(Date createdDate)
The timestamp when the stage was created.
createdDate
- The timestamp when the stage was created.public Date getCreatedDate()
The timestamp when the stage was created.
public UpdateStageResult withCreatedDate(Date createdDate)
The timestamp when the stage was created.
createdDate
- The timestamp when the stage was created.public void setLastUpdatedDate(Date lastUpdatedDate)
The timestamp when the stage last updated.
lastUpdatedDate
- The timestamp when the stage last updated.public Date getLastUpdatedDate()
The timestamp when the stage last updated.
public UpdateStageResult withLastUpdatedDate(Date lastUpdatedDate)
The timestamp when the stage last updated.
lastUpdatedDate
- The timestamp when the stage last updated.public String toString()
toString
in class Object
Object.toString()
public UpdateStageResult clone()