java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.DescribeVolumesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeVolumesRequest.Builder,DescribeVolumesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeVolumesRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeVolumesRequest.Builder,DescribeVolumesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeVolumesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeVolumesRequest.Builder`	`builder()`
`Boolean`	`dryRun()`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()`	The filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`boolean`	`hasVolumeIds()`	For responses, this returns true if the service returned a value for the VolumeIds property.
`Integer`	`maxResults()`	The maximum number of volumes to return for this request.
`String`	`nextToken()`	The token returned from a previous paginated request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeVolumesRequest.Builder>`	`serializableBuilderClass()`
`DescribeVolumesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`volumeIds()`	The volume IDs.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<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)
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    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)
  - hasVolumeIds
```
public final boolean hasVolumeIds()
```
    For responses, this returns true if the service returned a value for the VolumeIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - volumeIds
```
public final List<String> volumeIds()
```
    The volume IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVolumeIds() method.
    
    Returns:
    
    The volume IDs.
  - dryRun
```
public final Boolean dryRun()
```
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    
    Returns:
    
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - maxResults
```
public final 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.
    
    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.
  - nextToken
```
public final String nextToken()
```
    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.
  - toBuilder
```
public DescribeVolumesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeVolumesRequest.Builder,DescribeVolumesRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeVolumesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeVolumesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeVolumesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasFilters

filters

hasVolumeIds

volumeIds

dryRun

maxResults

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields