com.amazonaws.services.opsworks.model

Class DescribeDeploymentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.DescribeDeploymentsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeDeploymentsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDeployments operation.

Requests a description of a specified set of deployments.

NOTE: You must specify at least one of the parameters.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:

AWSOpsWorks.describeDeployments(DescribeDeploymentsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDeploymentsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDeploymentsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAppId() The app ID.
List<String>	getDeploymentIds() An array of deployment IDs to be described.
String	getStackId() The stack ID.
int	hashCode()
void	setAppId(String appId) The app ID.
void	setDeploymentIds(Collection<String> deploymentIds) An array of deployment IDs to be described.
void	setStackId(String stackId) The stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDeploymentsRequest	withAppId(String appId) The app ID.
DescribeDeploymentsRequest	withDeploymentIds(Collection<String> deploymentIds) An array of deployment IDs to be described.
DescribeDeploymentsRequest	withDeploymentIds(String... deploymentIds) An array of deployment IDs to be described.
DescribeDeploymentsRequest	withStackId(String stackId) The stack ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeDeploymentsRequest

public DescribeDeploymentsRequest()

Method Detail

getStackId

public String getStackId()

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

Returns:

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

setStackId

public void setStackId(String stackId)

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

Parameters:

stackId - The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

withStackId

public DescribeDeploymentsRequest withStackId(String stackId)

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

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

Parameters:

stackId - The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

Returns:

A reference to this updated object so that method calls can be chained together.

getAppId

public String getAppId()

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

Returns:

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

setAppId

public void setAppId(String appId)

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

Parameters:

appId - The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

withAppId

public DescribeDeploymentsRequest withAppId(String appId)

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

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

Parameters:

appId - The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

Returns:

A reference to this updated object so that method calls can be chained together.

getDeploymentIds

public List<String> getDeploymentIds()

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Returns:

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

setDeploymentIds

public void setDeploymentIds(Collection<String> deploymentIds)

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Parameters:

deploymentIds - An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

withDeploymentIds

public DescribeDeploymentsRequest withDeploymentIds(String... deploymentIds)

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

NOTE: This method appends the values to the existing list (if any). Use setDeploymentIds(java.util.Collection) or withDeploymentIds(java.util.Collection) if you want to override the existing values.

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

Parameters:

deploymentIds - An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Returns:

A reference to this updated object so that method calls can be chained together.

withDeploymentIds

public DescribeDeploymentsRequest withDeploymentIds(Collection<String> deploymentIds)

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

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

Parameters:

deploymentIds - An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeDeploymentsRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()