com.amazonaws.services.apigateway.model

Class CreateDeploymentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.CreateDeploymentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Requests API Gateway to create a Deployment resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeploymentRequest()

Method Summary

Modifier and Type	Method and Description
CreateDeploymentRequest	addVariablesEntry(String key, String value) Add a single Variables entry
CreateDeploymentRequest	clearVariablesEntries() Removes all the entries added into Variables.
CreateDeploymentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getCacheClusterEnabled() Enables a cache cluster for the Stage resource specified in the input.
String	getCacheClusterSize() The stage's cache capacity in GB.
DeploymentCanarySettings	getCanarySettings() The input configuration for the canary deployment when the deployment is a canary release deployment.
String	getDescription() The description for the Deployment resource to create.
String	getRestApiId() The string identifier of the associated RestApi.
String	getStageDescription() The description of the Stage resource for the Deployment resource to create.
String	getStageName() The name of the Stage resource for the Deployment resource to create.
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 Stage resource that is associated with the new deployment.
int	hashCode()
Boolean	isCacheClusterEnabled() Enables a cache cluster for the Stage resource specified in the input.
Boolean	isTracingEnabled() Specifies whether active tracing with X-ray is enabled for the Stage.
void	setCacheClusterEnabled(Boolean cacheClusterEnabled) Enables a cache cluster for the Stage resource specified in the input.
void	setCacheClusterSize(String cacheClusterSize) The stage's cache capacity in GB.
void	setCanarySettings(DeploymentCanarySettings canarySettings) The input configuration for the canary deployment when the deployment is a canary release deployment.
void	setDescription(String description) The description for the Deployment resource to create.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
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	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 Stage resource that is associated with the new deployment.
String	toString() Returns a string representation of this object.
CreateDeploymentRequest	withCacheClusterEnabled(Boolean cacheClusterEnabled) Enables a cache cluster for the Stage resource specified in the input.
CreateDeploymentRequest	withCacheClusterSize(String cacheClusterSize) The stage's cache capacity in GB.
CreateDeploymentRequest	withCanarySettings(DeploymentCanarySettings canarySettings) The input configuration for the canary deployment when the deployment is a canary release deployment.
CreateDeploymentRequest	withDescription(String description) The description for the Deployment resource to create.
CreateDeploymentRequest	withRestApiId(String restApiId) The string identifier of the associated RestApi.
CreateDeploymentRequest	withStageDescription(String stageDescription) The description of the Stage resource for the Deployment resource to create.
CreateDeploymentRequest	withStageName(String stageName) The name of the Stage resource for the Deployment resource to create.
CreateDeploymentRequest	withTracingEnabled(Boolean tracingEnabled) Specifies whether active tracing with X-ray is enabled for the Stage.
CreateDeploymentRequest	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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDeploymentRequest

public CreateDeploymentRequest()

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 CreateDeploymentRequest 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 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

public String 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

public CreateDeploymentRequest withStageName(String stageName)

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

public void setStageDescription(String stageDescription)

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

public String 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

public CreateDeploymentRequest withStageDescription(String stageDescription)

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

public void setDescription(String description)

The description for the Deployment resource to create.

Parameters:

description - The description for the Deployment resource to create.

getDescription

public String getDescription()

The description for the Deployment resource to create.

Returns:

The description for the Deployment resource to create.

withDescription

public CreateDeploymentRequest withDescription(String description)

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

public void setCacheClusterEnabled(Boolean cacheClusterEnabled)

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

public Boolean 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

public CreateDeploymentRequest withCacheClusterEnabled(Boolean cacheClusterEnabled)

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

public Boolean 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

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 CreateDeploymentRequest 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 Stage resource that is associated with the new deployment. 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 Stage resource that is associated with the new deployment. 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 Stage resource that is associated with the new deployment. 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 Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

withVariables

public CreateDeploymentRequest withVariables(Map<String,String> variables)

A map that defines the stage variables for the Stage resource that is associated with the new deployment. 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 Stage resource that is associated with the new deployment. 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 CreateDeploymentRequest addVariablesEntry(String key,
                                                 String value)

Add a single Variables entry

See Also:

withVariables(java.util.Map<java.lang.String, java.lang.String>)

clearVariablesEntries

public CreateDeploymentRequest clearVariablesEntries()

Removes all the entries added into Variables.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCanarySettings

public void setCanarySettings(DeploymentCanarySettings canarySettings)

The input configuration for the canary deployment when the deployment is a canary release deployment.

Parameters:

canarySettings - The input configuration for the canary deployment when the deployment is a canary release deployment.

getCanarySettings

public DeploymentCanarySettings getCanarySettings()

The input configuration for the canary deployment when the deployment is a canary release deployment.

Returns:

The input configuration for the canary deployment when the deployment is a canary release deployment.

withCanarySettings

public CreateDeploymentRequest withCanarySettings(DeploymentCanarySettings canarySettings)

The input configuration for the canary deployment when the deployment is a canary release deployment.

Parameters:

canarySettings - The input configuration for the canary deployment when the deployment is a canary release deployment.

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 CreateDeploymentRequest 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.

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 CreateDeploymentRequest 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()