DescribeSnapshotsRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeSnapshotsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSnapshotsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeSnapshotsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeSnapshotsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` The filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()` Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasOwnerIds()` Returns true if the OwnerIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasRestorableByUserIds()` Returns true if the RestorableByUserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSnapshotIds()` Returns true if the SnapshotIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`maxResults()` The maximum number of snapshot results returned by `DescribeSnapshots` in paginated output.
`String`	`nextToken()` The `NextToken` value returned from a previous paginated `DescribeSnapshots` request where `MaxResults` was used and the results exceeded the value of that parameter.
`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()
```
    Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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).
    - 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.
    
    You can use hasFilters() to see if a value was sent in this field.
    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).
    
    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 snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.
    
    Returns:
    
    The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.
  - nextToken
```
public final String nextToken()
```
    The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
    
    Returns:
    
    The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
  - hasOwnerIds
```
public final boolean hasOwnerIds()
```
    Returns true if the OwnerIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasOwnerIds() to see if a value was sent in this field.
    
    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()
```
    Returns true if the RestorableByUserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasRestorableByUserIds() to see if a value was sent in this field.
    
    Returns:
    
    The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
  - hasSnapshotIds
```
public final boolean hasSnapshotIds()
```
    Returns true if the SnapshotIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasSnapshotIds() to see if a value was sent in this field.
    
    Returns:
    
    The snapshot IDs.
    
    Default: Describes the snapshots for which you have create volume permissions.
  - 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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields