CreateStageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigateway.model.CreateStageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateStageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Requests API Gateway to create a Stage resource.

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateStageRequest()

Constructors
Constructor and Description
`CreateStageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateStageRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateStageRequest`	`addVariablesEntry(String key, String value)` Add a single Variables entry
`CreateStageRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateStageRequest`	`clearVariablesEntries()` Removes all the entries added into Variables.
`CreateStageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Boolean`	`getCacheClusterEnabled()` Whether cache clustering is enabled for the stage.
`String`	`getCacheClusterSize()` The stage's cache capacity in GB.
`CanarySettings`	`getCanarySettings()` The canary deployment settings of this stage.
`String`	`getDeploymentId()` The identifier of the Deployment resource for the Stage resource.
`String`	`getDescription()` The description of the Stage resource.
`String`	`getDocumentationVersion()` The version of the associated API documentation.
`String`	`getRestApiId()` The string identifier of the associated RestApi.
`String`	`getStageName()` The name for the Stage resource.
`Map<String,String>`	`getTags()` The key-value map of strings.
`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 the new Stage resource.
`int`	`hashCode()`
`Boolean`	`isCacheClusterEnabled()` Whether cache clustering is enabled for the stage.
`Boolean`	`isTracingEnabled()` Specifies whether active tracing with X-ray is enabled for the Stage.
`void`	`setCacheClusterEnabled(Boolean cacheClusterEnabled)` Whether cache clustering is enabled for the stage.
`void`	`setCacheClusterSize(String cacheClusterSize)` The stage's cache capacity in GB.
`void`	`setCanarySettings(CanarySettings canarySettings)` The canary deployment settings of this stage.
`void`	`setDeploymentId(String deploymentId)` The identifier of the Deployment resource for the Stage resource.
`void`	`setDescription(String description)` The description of the Stage resource.
`void`	`setDocumentationVersion(String documentationVersion)` The version of the associated API documentation.
`void`	`setRestApiId(String restApiId)` The string identifier of the associated RestApi.
`void`	`setStageName(String stageName)` The name for the Stage resource.
`void`	`setTags(Map<String,String> tags)` The key-value map of strings.
`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 the new Stage resource.
`String`	`toString()` Returns a string representation of this object.
`CreateStageRequest`	`withCacheClusterEnabled(Boolean cacheClusterEnabled)` Whether cache clustering is enabled for the stage.
`CreateStageRequest`	`withCacheClusterSize(String cacheClusterSize)` The stage's cache capacity in GB.
`CreateStageRequest`	`withCanarySettings(CanarySettings canarySettings)` The canary deployment settings of this stage.
`CreateStageRequest`	`withDeploymentId(String deploymentId)` The identifier of the Deployment resource for the Stage resource.
`CreateStageRequest`	`withDescription(String description)` The description of the Stage resource.
`CreateStageRequest`	`withDocumentationVersion(String documentationVersion)` The version of the associated API documentation.
`CreateStageRequest`	`withRestApiId(String restApiId)` The string identifier of the associated RestApi.
`CreateStageRequest`	`withStageName(String stageName)` The name for the Stage resource.
`CreateStageRequest`	`withTags(Map<String,String> tags)` The key-value map of strings.
`CreateStageRequest`	`withTracingEnabled(Boolean tracingEnabled)` Specifies whether active tracing with X-ray is enabled for the Stage.
`CreateStageRequest`	`withVariables(Map<String,String> variables)` A map that defines the stage variables for the new Stage resource.

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

- Constructor Detail
  - CreateStageRequest
```
public CreateStageRequest()
```
- Method Detail
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
  - getRestApiId
```
public String getRestApiId()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - withRestApiId
```
public CreateStageRequest withRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
    
    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. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    
    Parameters:
    
    stageName - The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
  - getStageName
```
public String getStageName()
```
    The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    
    Returns:
    
    The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
  - withStageName
```
public CreateStageRequest withStageName(String stageName)
```
    The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    
    Parameters:
    
    stageName - The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    
    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 capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
    
    Parameters:
    
    cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
  - getCacheClusterSize
```
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.
    
    Returns:
    
    The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
  - withCacheClusterSize
```
public CreateStageRequest 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.
    
    Parameters:
    
    cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
    
    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 and underscore 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 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 the new 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 the new Stage resource. Variable names can have alphanumeric and underscore 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 and underscore 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 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 CreateStageRequest addVariablesEntry(String key,
                                            String value)
```
    Add a single Variables entry
    
    See Also:
    
    withVariables(java.util.Map<java.lang.String, java.lang.String>)
  - clearVariablesEntries
```
public CreateStageRequest 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 CreateStageRequest 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.
  - setCanarySettings
```
public void setCanarySettings(CanarySettings canarySettings)
```
    The canary deployment settings of this stage.
    
    Parameters:
    
    canarySettings - The canary deployment settings of this stage.
  - getCanarySettings
```
public CanarySettings getCanarySettings()
```
    The canary deployment settings of this stage.
    
    Returns:
    
    The canary deployment settings of this stage.
  - withCanarySettings
```
public CreateStageRequest withCanarySettings(CanarySettings canarySettings)
```
    The canary deployment settings of this stage.
    
    Parameters:
    
    canarySettings - The canary deployment settings of this stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTracingEnabled
```
public void setTracingEnabled(Boolean tracingEnabled)
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
    
    Parameters:
    
    tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.
  - getTracingEnabled
```
public Boolean getTracingEnabled()
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
    
    Returns:
    
    Specifies whether active tracing with X-ray is enabled for the Stage.
  - withTracingEnabled
```
public CreateStageRequest withTracingEnabled(Boolean tracingEnabled)
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
    
    Parameters:
    
    tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isTracingEnabled
```
public Boolean isTracingEnabled()
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
    
    Returns:
    
    Specifies whether active tracing with X-ray is enabled for the Stage.
  - getTags
```
public Map<String,String> getTags()
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Returns:
    
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Parameters:
    
    tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
  - withTags
```
public CreateStageRequest withTags(Map<String,String> tags)
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Parameters:
    
    tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateStageRequest addTagsEntry(String key,
                                       String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateStageRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 CreateStageRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.779

Class CreateStageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateStageRequest

Method Detail

setRestApiId

getRestApiId

withRestApiId

setStageName

getStageName

withStageName

setDeploymentId

getDeploymentId

withDeploymentId

setDescription

getDescription

withDescription

setCacheClusterEnabled

getCacheClusterEnabled

withCacheClusterEnabled

isCacheClusterEnabled

setCacheClusterSize

getCacheClusterSize

withCacheClusterSize

getVariables

setVariables

withVariables

addVariablesEntry

clearVariablesEntries

setDocumentationVersion

getDocumentationVersion

withDocumentationVersion

setCanarySettings

getCanarySettings

withCanarySettings

setTracingEnabled

getTracingEnabled

withTracingEnabled

isTracingEnabled

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone