com.amazonaws.services.ec2.model
Class DescribeVolumesRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.ec2.model.DescribeVolumesRequest

public class DescribeVolumesRequest
extends AmazonWebServiceRequest

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)

Constructor Summary
DescribeVolumesRequest()
          Default constructor for a new DescribeVolumesRequest object.
DescribeVolumesRequest(List<String> volumeIds)
          Constructs a new DescribeVolumesRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 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, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
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.

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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.