Interface DescribeBackupsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeBackupsRequest.Builder,
,DescribeBackupsRequest> FSxRequest.Builder
,SdkBuilder<DescribeBackupsRequest.Builder,
,DescribeBackupsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeBackupsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe IDs of the backups that you want to retrieve.backupIds
(Collection<String> backupIds) The IDs of the backups that you want to retrieve.filters
(Collection<Filter> filters) The filters structure.filters
(Consumer<Filter.Builder>... filters) The filters structure.The filters structure.maxResults
(Integer maxResults) Maximum number of backups to return in the response.An opaque pagination token returned from a previousDescribeBackups
operation.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.fsx.model.FSxRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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, aBackupNotFound
error occurs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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, aBackupNotFound
error occurs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
The filters structure. The supported names are
file-system-id
,backup-type
,file-system-type
, andvolume-id
.- Parameters:
filters
- The filters structure. The supported names arefile-system-id
,backup-type
,file-system-type
, andvolume-id
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
The filters structure. The supported names are
file-system-id
,backup-type
,file-system-type
, andvolume-id
.- Parameters:
filters
- The filters structure. The supported names arefile-system-id
,backup-type
,file-system-type
, andvolume-id
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
The filters structure. The supported names are
This is a convenience method that creates an instance of thefile-system-id
,backup-type
,file-system-type
, andvolume-id
.Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theMaxResults
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
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 previousDescribeBackups
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-