com.amazonaws.services.opsworks.model

Class DescribeStacksRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.DescribeStacksRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeStacksRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeStacks operation.

Requests a description of one or more stacks.

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.describeStacks(DescribeStacksRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeStacksRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeStacksRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getStackIds() An array of stack IDs that specify the stacks to be described.
int	hashCode()
void	setStackIds(Collection<String> stackIds) An array of stack IDs that specify the stacks to be described.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeStacksRequest	withStackIds(Collection<String> stackIds) An array of stack IDs that specify the stacks to be described.
DescribeStacksRequest	withStackIds(String... stackIds) An array of stack IDs that specify the stacks to be described.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeStacksRequest

public DescribeStacksRequest()

Method Detail

getStackIds

public List<String> getStackIds()

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

Returns:

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

setStackIds

public void setStackIds(Collection<String> stackIds)

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

Parameters:

stackIds - An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

withStackIds

public DescribeStacksRequest withStackIds(String... stackIds)

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

NOTE: This method appends the values to the existing list (if any). Use setStackIds(java.util.Collection) or withStackIds(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:

stackIds - An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

Returns:

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

withStackIds

public DescribeStacksRequest withStackIds(Collection<String> stackIds)

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

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

Parameters:

stackIds - An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

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