DescribeSnapshotsRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>, Ec2Request.Builder, SdkBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeSnapshotsRequest
```
public static interface DescribeSnapshotsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DescribeSnapshotsRequest.Builder`	`filters(Collection<Filter> filters)` The filters.
`DescribeSnapshotsRequest.Builder`	`filters(Consumer<Filter.Builder>... filters)` The filters.
`DescribeSnapshotsRequest.Builder`	`filters(Filter... filters)` The filters.
`DescribeSnapshotsRequest.Builder`	`maxResults(Integer maxResults)` The maximum number of snapshot results returned by `DescribeSnapshots` in paginated output.
`DescribeSnapshotsRequest.Builder`	`nextToken(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.
`DescribeSnapshotsRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`DescribeSnapshotsRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`DescribeSnapshotsRequest.Builder`	`ownerIds(Collection<String> ownerIds)` Describes the snapshots owned by these owners.
`DescribeSnapshotsRequest.Builder`	`ownerIds(String... ownerIds)` Describes the snapshots owned by these owners.
`DescribeSnapshotsRequest.Builder`	`restorableByUserIds(Collection<String> restorableByUserIds)` The IDs of the AWS accounts that can create volumes from the snapshot.
`DescribeSnapshotsRequest.Builder`	`restorableByUserIds(String... restorableByUserIds)` The IDs of the AWS accounts that can create volumes from the snapshot.
`DescribeSnapshotsRequest.Builder`	`snapshotIds(Collection<String> snapshotIds)` The snapshot IDs.
`DescribeSnapshotsRequest.Builder`	`snapshotIds(String... snapshotIds)` The snapshot IDs.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - filters
```
DescribeSnapshotsRequest.Builder filters(Collection<Filter> filters)
```
    The filters.
    - description - A description of the snapshot.
    - encrypted - Indicates whether the snapshot is encrypted (true | false)
    - owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
    - owner-id - The ID of the AWS account that owns the snapshot.
    - 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.
    Parameters:
    filters - The filters.
    
    description - A description of the snapshot.
    
    encrypted - Indicates whether the snapshot is encrypted (true | false)
    
    owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
    
    owner-id - The ID of the AWS account that owns the snapshot.
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
DescribeSnapshotsRequest.Builder filters(Filter... filters)
```
    The filters.
    - description - A description of the snapshot.
    - encrypted - Indicates whether the snapshot is encrypted (true | false)
    - owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
    - owner-id - The ID of the AWS account that owns the snapshot.
    - 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.
    Parameters:
    filters - The filters.
    
    description - A description of the snapshot.
    
    encrypted - Indicates whether the snapshot is encrypted (true | false)
    
    owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
    
    owner-id - The ID of the AWS account that owns the snapshot.
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
DescribeSnapshotsRequest.Builder filters(Consumer<Filter.Builder>... filters)
```
    The filters.
    - description - A description of the snapshot.
    - encrypted - Indicates whether the snapshot is encrypted (true | false)
    - owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
    - owner-id - The ID of the AWS account that owns the snapshot.
    - 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.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).
    Parameters:
    
    filters - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #filters(List)
  - maxResults
```
DescribeSnapshotsRequest.Builder maxResults(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 1000; if MaxResults is given a value larger than 1000, only 1000 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.
    
    Parameters:
    
    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 1000; if MaxResults is given a value larger than 1000, only 1000 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - nextToken
```
DescribeSnapshotsRequest.Builder nextToken(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - ownerIds
```
DescribeSnapshotsRequest.Builder ownerIds(Collection<String> ownerIds)
```
    Describes the snapshots owned by these owners.
    
    Parameters:
    
    ownerIds - Describes the snapshots owned by these owners.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ownerIds
```
DescribeSnapshotsRequest.Builder ownerIds(String... ownerIds)
```
    Describes the snapshots owned by these owners.
    
    Parameters:
    
    ownerIds - Describes the snapshots owned by these owners.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - restorableByUserIds
```
DescribeSnapshotsRequest.Builder restorableByUserIds(Collection<String> restorableByUserIds)
```
    The IDs of the AWS accounts that can create volumes from the snapshot.
    
    Parameters:
    
    restorableByUserIds - The IDs of the AWS accounts that can create volumes from the snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - restorableByUserIds
```
DescribeSnapshotsRequest.Builder restorableByUserIds(String... restorableByUserIds)
```
    The IDs of the AWS accounts that can create volumes from the snapshot.
    
    Parameters:
    
    restorableByUserIds - The IDs of the AWS accounts that can create volumes from the snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - snapshotIds
```
DescribeSnapshotsRequest.Builder snapshotIds(Collection<String> snapshotIds)
```
    The snapshot IDs.
    
    Default: Describes the snapshots for which you have create volume permissions.
    
    Parameters:
    
    snapshotIds - The snapshot IDs.
    
    Default: Describes the snapshots for which you have create volume permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - snapshotIds
```
DescribeSnapshotsRequest.Builder snapshotIds(String... snapshotIds)
```
    The snapshot IDs.
    
    Default: Describes the snapshots for which you have create volume permissions.
    
    Parameters:
    
    snapshotIds - The snapshot IDs.
    
    Default: Describes the snapshots for which you have create volume permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
DescribeSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
DescribeSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface DescribeSnapshotsRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

filters

filters

filters

maxResults

nextToken

ownerIds

ownerIds

restorableByUserIds

restorableByUserIds

snapshotIds

snapshotIds

overrideConfiguration

overrideConfiguration