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.DescribeSnapshotsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeSnapshotsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeSnapshotsRequest.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`	`hasOwnerIds()`	For responses, this returns true if the service returned a value for the OwnerIds property.
`boolean`	`hasRestorableByUserIds()`	For responses, this returns true if the service returned a value for the RestorableByUserIds property.
`boolean`	`hasSnapshotIds()`	For responses, this returns true if the service returned a value for the SnapshotIds property.
`Integer`	`maxResults()`	The maximum number of snapshots to return for this request.
`String`	`nextToken()`	The token returned from a previous paginated request.
`List<String>`	`ownerIds()`	Scopes the results to snapshots with the specified owners.
`List<String>`	`restorableByUserIds()`	The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeSnapshotsRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`snapshotIds()`	The snapshot IDs.
`DescribeSnapshotsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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.
    
    description - A description of the snapshot.
    
    encrypted - Indicates whether the snapshot is encrypted (true | false)
    
    owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
    
    owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
    
    progress - The progress of the snapshot, as a percentage (for example, 80%).
    
    snapshot-id - The snapshot ID.
    
    start-time - The time stamp when the snapshot was initiated.
    
    status - The status of the snapshot (pending | completed | error).
    
    storage-tier - The storage tier of the snapshot (archive | standard).
    
    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 ID of the volume the snapshot is for.
    
    volume-size - The size of the volume, in GiB.
    
    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.
    
    description - A description of the snapshot.
    
    encrypted - Indicates whether the snapshot is encrypted (true | false)
    
    owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
    
    owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
    
    progress - The progress of the snapshot, as a percentage (for example, 80%).
    
    snapshot-id - The snapshot ID.
    
    start-time - The time stamp when the snapshot was initiated.
    
    status - The status of the snapshot (pending | completed | error).
    
    storage-tier - The storage tier of the snapshot (archive | standard).
    
    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 ID of the volume the snapshot is for.
    
    volume-size - The size of the volume, in GiB.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of snapshots to return for this request. This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then the request returns all snapshots. You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, see Pagination.
    
    Returns:
    
    The maximum number of snapshots to return for this request. This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then the request returns all snapshots. You cannot specify this parameter and the snapshot 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 by the previous request.
    
    Returns:
    
    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
  - hasOwnerIds
```
public final boolean hasOwnerIds()
```
    For responses, this returns true if the service returned a value for the OwnerIds 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.
  - ownerIds
```
public final List<String> ownerIds()
```
    Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
    
    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 hasOwnerIds() method.
    
    Returns:
    
    Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
  - hasRestorableByUserIds
```
public final boolean hasRestorableByUserIds()
```
    For responses, this returns true if the service returned a value for the RestorableByUserIds 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.
  - restorableByUserIds
```
public final List<String> restorableByUserIds()
```
    The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
    
    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 hasRestorableByUserIds() method.
    
    Returns:
    
    The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
  - hasSnapshotIds
```
public final boolean hasSnapshotIds()
```
    For responses, this returns true if the service returned a value for the SnapshotIds 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.
  - snapshotIds
```
public final List<String> snapshotIds()
```
    The snapshot IDs.
    
    Default: Describes the snapshots for which you have create volume permissions.
    
    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 hasSnapshotIds() method.
    
    Returns:
    
    The snapshot IDs.
    
    Default: Describes the snapshots for which you have create volume permissions.
  - 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.
  - toBuilder
```
public DescribeSnapshotsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeSnapshotsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSnapshotsRequest.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 DescribeSnapshotsRequest

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

maxResults

nextToken

hasOwnerIds

ownerIds

hasRestorableByUserIds

restorableByUserIds

hasSnapshotIds

snapshotIds

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields