software.amazon.awssdk.services.fsx.model

Interface DescribeBackupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>, FSxRequest.Builder, SdkBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeBackupsRequest

public static interface DescribeBackupsRequest.Builder
extends FSxRequest.Builder, SdkPojo, CopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeBackupsRequest.Builder	backupIds(Collection<String> backupIds) (Optional) IDs of the backups you want to retrieve (String).
DescribeBackupsRequest.Builder	backupIds(String... backupIds) (Optional) IDs of the backups you want to retrieve (String).
DescribeBackupsRequest.Builder	filters(Collection<Filter> filters) (Optional) Filters structure.
DescribeBackupsRequest.Builder	filters(Consumer<Filter.Builder>... filters) (Optional) Filters structure.
DescribeBackupsRequest.Builder	filters(Filter... filters) (Optional) Filters structure.
DescribeBackupsRequest.Builder	maxResults(Integer maxResults) (Optional) Maximum number of backups to return in the response (integer).
DescribeBackupsRequest.Builder	nextToken(String nextToken) (Optional) Opaque pagination token returned from a previous DescribeBackups operation (String).
DescribeBackupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeBackupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.fsx.model.FSxRequest.Builder

build

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

overrideConfiguration

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

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

backupIds

DescribeBackupsRequest.Builder backupIds(Collection<String> backupIds)

(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Parameters:

backupIds - (Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Returns:

Returns a reference to this object so that method calls can be chained together.

backupIds

DescribeBackupsRequest.Builder backupIds(String... backupIds)

(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Parameters:

backupIds - (Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeBackupsRequest.Builder filters(Collection<Filter> filters)

(Optional) Filters structure. Supported names are file-system-id and backup-type.

Parameters:

filters - (Optional) Filters structure. Supported names are file-system-id and backup-type.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeBackupsRequest.Builder filters(Filter... filters)

(Optional) Filters structure. Supported names are file-system-id and backup-type.

Parameters:

filters - (Optional) Filters structure. Supported names are file-system-id and backup-type.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeBackupsRequest.Builder filters(Consumer<Filter.Builder>... filters)

(Optional) Filters structure. Supported names are file-system-id and backup-type.

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

DescribeBackupsRequest.Builder maxResults(Integer maxResults)

(Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Parameters:

maxResults - (Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeBackupsRequest.Builder nextToken(String nextToken)

(Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Parameters:

nextToken - (Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

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

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