Class CreateDeploymentRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Requests Amazon API Gateway to create a Deployment resource.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddVariablesEntry
(String key, String value) Removes all the entries added into Variables.clone()
Creates a shallow clone of this request.boolean
Enables a cache cluster for the Stage resource specified in the input.Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.The description for the Deployment resource to create.The RestApi resource identifier for the Deployment resource to create.The description of the Stage resource for the Deployment resource to create.The name of the Stage resource for the Deployment resource to create.A map that defines the stage variables for the Stage resource that is associated with the new deployment.int
hashCode()
Enables a cache cluster for the Stage resource specified in the input.void
setCacheClusterEnabled
(Boolean cacheClusterEnabled) Enables a cache cluster for the Stage resource specified in the input.void
setCacheClusterSize
(String cacheClusterSize) Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.void
setDescription
(String description) The description for the Deployment resource to create.void
setRestApiId
(String restApiId) The RestApi resource identifier for the Deployment resource to create.void
setStageDescription
(String stageDescription) The description of the Stage resource for the Deployment resource to create.void
setStageName
(String stageName) The name of the Stage resource for the Deployment resource to create.void
setVariables
(Map<String, String> variables) A map that defines the stage variables for the Stage resource that is associated with the new deployment.toString()
Returns a string representation of this object; useful for testing and debugging.withCacheClusterEnabled
(Boolean cacheClusterEnabled) Enables a cache cluster for the Stage resource specified in the input.withCacheClusterSize
(String cacheClusterSize) Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.withDescription
(String description) The description for the Deployment resource to create.withRestApiId
(String restApiId) The RestApi resource identifier for the Deployment resource to create.withStageDescription
(String stageDescription) The description of the Stage resource for the Deployment resource to create.withStageName
(String stageName) The name of the Stage resource for the Deployment resource to create.withVariables
(Map<String, String> variables) A map that defines the stage variables for the Stage resource that is associated with the new deployment.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateDeploymentRequest
public CreateDeploymentRequest()
-
-
Method Details
-
setRestApiId
The RestApi resource identifier for the Deployment resource to create.
- Parameters:
restApiId
- The RestApi resource identifier for the Deployment resource to create.
-
getRestApiId
The RestApi resource identifier for the Deployment resource to create.
- Returns:
- The RestApi resource identifier for the Deployment resource to create.
-
withRestApiId
The RestApi resource identifier for the Deployment resource to create.
- Parameters:
restApiId
- The RestApi resource identifier for the Deployment resource to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStageName
The name of the Stage resource for the Deployment resource to create.
- Parameters:
stageName
- The name of the Stage resource for the Deployment resource to create.
-
getStageName
The name of the Stage resource for the Deployment resource to create.
- Returns:
- The name of the Stage resource for the Deployment resource to create.
-
withStageName
The name of the Stage resource for the Deployment resource to create.
- Parameters:
stageName
- The name of the Stage resource for the Deployment resource to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStageDescription
The description of the Stage resource for the Deployment resource to create.
- Parameters:
stageDescription
- The description of the Stage resource for the Deployment resource to create.
-
getStageDescription
The description of the Stage resource for the Deployment resource to create.
- Returns:
- The description of the Stage resource for the Deployment resource to create.
-
withStageDescription
The description of the Stage resource for the Deployment resource to create.
- Parameters:
stageDescription
- The description of the Stage resource for the Deployment resource to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
The description for the Deployment resource to create.
- Parameters:
description
- The description for the Deployment resource to create.
-
getDescription
The description for the Deployment resource to create.
- Returns:
- The description for the Deployment resource to create.
-
withDescription
The description for the Deployment resource to create.
- Parameters:
description
- The description for the Deployment resource to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheClusterEnabled
Enables a cache cluster for the Stage resource specified in the input.
- Parameters:
cacheClusterEnabled
- Enables a cache cluster for the Stage resource specified in the input.
-
getCacheClusterEnabled
Enables a cache cluster for the Stage resource specified in the input.
- Returns:
- Enables a cache cluster for the Stage resource specified in the input.
-
withCacheClusterEnabled
Enables a cache cluster for the Stage resource specified in the input.
- Parameters:
cacheClusterEnabled
- Enables a cache cluster for the Stage resource specified in the input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isCacheClusterEnabled
Enables a cache cluster for the Stage resource specified in the input.
- Returns:
- Enables a cache cluster for the Stage resource specified in the input.
-
setCacheClusterSize
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
- Parameters:
cacheClusterSize
- Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
-
getCacheClusterSize
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
- Returns:
- Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
-
withCacheClusterSize
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
- Parameters:
cacheClusterSize
- Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getVariables
A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.- Returns:
- A map that defines the stage variables for the Stage
resource that is associated with the new deployment. Variable
names can have alphanumeric characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.
-
setVariables
A map that defines the stage variables for the Stage resource that is associated with the new deployment. 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 the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match[A-Za-z0-9-._~:/?#&=,]+
.
-
withVariables
A map that defines the stage variables for the Stage resource that is associated with the new deployment. 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 the Stage resource that is associated with the new deployment. 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. -
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-