com.amazonaws.services.ec2.model

Class DescribeVolumesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVolumesRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVolumesRequest>, Serializable

public class DescribeVolumesRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeVolumesRequest>

Container for the parameters to the DescribeVolumes operation.

Describes the status of the indicated volume or, in lieu of any specified, all volumes belonging to the caller. Volumes that have been deleted are not described.

See Also:

AmazonEC2.describeVolumes(DescribeVolumesRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeVolumesRequest() Default constructor for a new DescribeVolumesRequest object.
DescribeVolumesRequest(List<String> volumeIds) Constructs a new DescribeVolumesRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeVolumesRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for Volumes.
List<String>	getVolumeIds() The optional list of EBS volumes to describe.
int	hashCode()
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for Volumes.
void	setVolumeIds(Collection<String> volumeIds) The optional list of EBS volumes to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVolumesRequest	withFilters(Collection<Filter> filters) A list of filters used to match properties for Volumes.
DescribeVolumesRequest	withFilters(Filter... filters) A list of filters used to match properties for Volumes.
DescribeVolumesRequest	withVolumeIds(Collection<String> volumeIds) The optional list of EBS volumes to describe.
DescribeVolumesRequest	withVolumeIds(String... volumeIds) The optional list of EBS volumes to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVolumesRequest

public DescribeVolumesRequest()

Default constructor for a new DescribeVolumesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DescribeVolumesRequest

public DescribeVolumesRequest(List<String> volumeIds)

Constructs a new DescribeVolumesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

volumeIds - The optional list of EBS volumes to describe.

Method Detail

getVolumeIds

public List<String> getVolumeIds()

The optional list of EBS volumes to describe.

Returns:

The optional list of EBS volumes to describe.

setVolumeIds

public void setVolumeIds(Collection<String> volumeIds)

The optional list of EBS volumes to describe.

Parameters:

volumeIds - The optional list of EBS volumes to describe.

withVolumeIds

public DescribeVolumesRequest withVolumeIds(String... volumeIds)

The optional list of EBS volumes to describe.

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

Parameters:

volumeIds - The optional list of EBS volumes to describe.

Returns:

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

withVolumeIds

public DescribeVolumesRequest withVolumeIds(Collection<String> volumeIds)

The optional list of EBS volumes to describe.

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

Parameters:

volumeIds - The optional list of EBS volumes to describe.

Returns:

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

getFilters

public List<Filter> getFilters()

A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setFilters

public void setFilters(Collection<Filter> filters)

A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:

filters - A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeVolumesRequest withFilters(Filter... filters)

A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:

filters - A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

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

withFilters

public DescribeVolumesRequest withFilters(Collection<Filter> filters)

A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

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

Parameters:

filters - A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

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

getDryRunRequest

public Request<DescribeVolumesRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeVolumesRequest>

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