Interface DescribeSnapshotsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>, FSxRequest.Builder, SdkBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeSnapshotsRequest
@Mutable @NotThreadSafe public static interface DescribeSnapshotsRequest.Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

  • Method Details

    • snapshotIds

      DescribeSnapshotsRequest.Builder snapshotIds(Collection<String> snapshotIds)

      The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

      Parameters:
      snapshotIds - The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snapshotIds

      DescribeSnapshotsRequest.Builder snapshotIds(String... snapshotIds)

      The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

      Parameters:
      snapshotIds - The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeSnapshotsRequest.Builder filters(Collection<SnapshotFilter> filters)

      The filters structure. The supported names are file-system-id or volume-id.

      Parameters:
      filters - The filters structure. The supported names are file-system-id or volume-id.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeSnapshotsRequest.Builder filters(SnapshotFilter... filters)

      The filters structure. The supported names are file-system-id or volume-id.

      Parameters:
      filters - The filters structure. The supported names are file-system-id or volume-id.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeSnapshotsRequest.Builder filters(Consumer<SnapshotFilter.Builder>... filters)

      The filters structure. The supported names are file-system-id or volume-id.

      This is a convenience method that creates an instance of the SnapshotFilter.Builder avoiding the need to create one manually via SnapshotFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<SnapshotFilter>).

      Parameters:
      filters - a consumer that will call methods on SnapshotFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      DescribeSnapshotsRequest.Builder maxResults(Integer maxResults)
      Sets the value of the MaxResults property for this object.
      Parameters:
      maxResults - The new value for the MaxResults property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeSnapshotsRequest.Builder nextToken(String nextToken)
      Sets the value of the NextToken property for this object.
      Parameters:
      nextToken - The new value for the NextToken property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeShared

      DescribeSnapshotsRequest.Builder includeShared(Boolean includeShared)

      Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

      Parameters:
      includeShared - Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.