com.amazonaws.services.opsworks.model

Class DescribeLayersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.DescribeLayersRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeLayersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeLayers operation.

Requests a description of one or more layers in a specified stack.

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.describeLayers(DescribeLayersRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeLayersRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeLayersRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getLayerIds() An array of layer IDs that specify the layers to be described.
String	getStackId() The stack ID.
int	hashCode()
void	setLayerIds(Collection<String> layerIds) An array of layer IDs that specify the layers to be described.
void	setStackId(String stackId) The stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeLayersRequest	withLayerIds(Collection<String> layerIds) An array of layer IDs that specify the layers to be described.
DescribeLayersRequest	withLayerIds(String... layerIds) An array of layer IDs that specify the layers to be described.
DescribeLayersRequest	withStackId(String stackId) The stack ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

DescribeLayersRequest

public DescribeLayersRequest()

Method Detail

getStackId

public String getStackId()

The stack ID.

Returns:

The stack ID.

setStackId

public void setStackId(String stackId)

The stack ID.

Parameters:

stackId - The stack ID.

withStackId

public DescribeLayersRequest withStackId(String stackId)

The stack ID.

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

Parameters:

stackId - The stack ID.

Returns:

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

getLayerIds

public List<String> getLayerIds()

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

Returns:

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

setLayerIds

public void setLayerIds(Collection<String> layerIds)

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

Parameters:

layerIds - An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

withLayerIds

public DescribeLayersRequest withLayerIds(String... layerIds)

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

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

layerIds - An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

Returns:

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

withLayerIds

public DescribeLayersRequest withLayerIds(Collection<String> layerIds)

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

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

Parameters:

layerIds - An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified 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 DescribeLayersRequest 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()