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) The IDs of the backups that you want to retrieve.
DescribeBackupsRequest.Builder	backupIds(String... backupIds) The IDs of the backups that you want to retrieve.
DescribeBackupsRequest.Builder	filters(Collection<Filter> filters) The filters structure.
DescribeBackupsRequest.Builder	filters(Consumer<Filter.Builder>... filters) The filters structure.
DescribeBackupsRequest.Builder	filters(Filter... filters) The filters structure.
DescribeBackupsRequest.Builder	maxResults(Integer maxResults) Maximum number of backups to return in the response.
DescribeBackupsRequest.Builder	nextToken(String nextToken) An opaque pagination token returned from a previous DescribeBackups operation.
DescribeBackupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeBackupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

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

backupIds

DescribeBackupsRequest.Builder backupIds(Collection<String> backupIds)

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

Parameters:

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

Returns:

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

backupIds

DescribeBackupsRequest.Builder backupIds(String... backupIds)

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

Parameters:

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

Returns:

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

filters

DescribeBackupsRequest.Builder filters(Collection<Filter> filters)

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Parameters:

filters - The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Returns:

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

filters

DescribeBackupsRequest.Builder filters(Filter... filters)

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Parameters:

filters - The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

Returns:

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

filters

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

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

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

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

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

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

See Also:

#filters(java.util.Collection)

maxResults

DescribeBackupsRequest.Builder maxResults(Integer maxResults)

Maximum number of backups to return in the response. 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 - Maximum number of backups to return in the response. 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)

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Parameters:

nextToken - An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeBackupsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder