DescribeVolumesRequest (AWS Java SDK for Amazon EC2 1.12.667 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeVolumesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeVolumesRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeVolumesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeVolumesRequest>

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeVolumesRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Request<DescribeVolumesRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`List<Filter>`	`getFilters()` The filters.
`Integer`	`getMaxResults()` The maximum number of volumes to return for this request.
`String`	`getNextToken()` The token returned from a previous paginated request.
`List<String>`	`getVolumeIds()` The volume IDs.
`int`	`hashCode()`
`void`	`setFilters(Collection<Filter> filters)` The filters.
`void`	`setMaxResults(Integer maxResults)` The maximum number of volumes to return for this request.
`void`	`setNextToken(String nextToken)` The token returned from a previous paginated request.
`void`	`setVolumeIds(Collection<String> volumeIds)` The volume IDs.
`String`	`toString()` Returns a string representation of this object.
`DescribeVolumesRequest`	`withFilters(Collection<Filter> filters)` The filters.
`DescribeVolumesRequest`	`withFilters(Filter... filters)` The filters.
`DescribeVolumesRequest`	`withMaxResults(Integer maxResults)` The maximum number of volumes to return for this request.
`DescribeVolumesRequest`	`withNextToken(String nextToken)` The token returned from a previous paginated request.
`DescribeVolumesRequest`	`withVolumeIds(Collection<String> volumeIds)` The volume IDs.
`DescribeVolumesRequest`	`withVolumeIds(String... volumeIds)` The volume IDs.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeVolumesRequest
```
public DescribeVolumesRequest()
```
    Default constructor for DescribeVolumesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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 volume IDs.
- Method Detail
  - getFilters
```
public List<Filter> getFilters()
```
    The filters.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - Indicates whether the volume is encrypted (true | false)
    - multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
    - fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
    Returns:
    The filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - Indicates whether the volume is encrypted (true | false)
    
    multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach ( true | false)
    
    fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
  - setFilters
```
public void setFilters(Collection<Filter> filters)
```
    The filters.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - Indicates whether the volume is encrypted (true | false)
    - multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
    - fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
    Parameters:
    filters - The filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - Indicates whether the volume is encrypted (true | false )
    
    multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach ( true | false)
    
    fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
  - withFilters
```
public DescribeVolumesRequest withFilters(Filter... filters)
```
    The filters.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - Indicates whether the volume is encrypted (true | false)
    - multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
    - fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
    NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.
    Parameters:
    filters - The filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - Indicates whether the volume is encrypted (true | false )
    
    multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach ( true | false)
    
    fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilters
```
public DescribeVolumesRequest withFilters(Collection<Filter> filters)
```
    The filters.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - Indicates whether the volume is encrypted (true | false)
    - multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
    - fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
    Parameters:
    filters - The filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - Indicates whether the volume is encrypted (true | false )
    
    multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach ( true | false)
    
    fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The state of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVolumeIds
```
public List<String> getVolumeIds()
```
    The volume IDs.
    
    Returns:
    
    The volume IDs.
  - setVolumeIds
```
public void setVolumeIds(Collection<String> volumeIds)
```
    The volume IDs.
    
    Parameters:
    
    volumeIds - The volume IDs.
  - withVolumeIds
```
public DescribeVolumesRequest withVolumeIds(String... volumeIds)
```
    The volume IDs.
    
    NOTE: This method appends the values to the existing list (if any). Use setVolumeIds(java.util.Collection) or withVolumeIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    volumeIds - The volume IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVolumeIds
```
public DescribeVolumesRequest withVolumeIds(Collection<String> volumeIds)
```
    The volume IDs.
    
    Parameters:
    
    volumeIds - The volume IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
    
    Parameters:
    
    maxResults - The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
    
    Returns:
    
    The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
  - withMaxResults
```
public DescribeVolumesRequest withMaxResults(Integer maxResults)
```
    The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
    
    Parameters:
    
    maxResults - The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
    
    Parameters:
    
    nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
  - getNextToken
```
public String getNextToken()
```
    The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
    
    Returns:
    
    The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
  - withNextToken
```
public DescribeVolumesRequest withNextToken(String nextToken)
```
    The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
    
    Parameters:
    
    nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
    
    Returns:
    
    Returns a reference to this 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeVolumesRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class DescribeVolumesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeVolumesRequest

DescribeVolumesRequest

Method Detail

getFilters

setFilters

withFilters

withFilters

getVolumeIds

setVolumeIds

withVolumeIds

withVolumeIds

setMaxResults

getMaxResults

withMaxResults

setNextToken

getNextToken

withNextToken

getDryRunRequest

toString

equals

hashCode

clone