Interface DescribeBackupsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudHsmV2Request.Builder
,CopyableBuilder<DescribeBackupsRequest.Builder,
,DescribeBackupsRequest> SdkBuilder<DescribeBackupsRequest.Builder,
,DescribeBackupsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeBackupsRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Map<String, ? extends Collection<String>> filters) One or more filters to limit the items returned in the response.maxResults
(Integer maxResults) The maximum number of backups to return in the response.TheNextToken
value that you received in the previous response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sortAscending
(Boolean sortAscending) Designates whether or not to sort the return backups by ascending chronological order of generation.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudhsmv2.model.CloudHsmV2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
nextToken
The
NextToken
value that you received in the previous response. Use this value to get more backups.- Parameters:
nextToken
- TheNextToken
value that you received in the previous response. Use this value to get more backups.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a
NextToken
value.- Parameters:
maxResults
- The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains aNextToken
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
One or more filters to limit the items returned in the response.
Use the
backupIds
filter to return only the specified backups. Specify backups by their backup identifier (ID).Use the
sourceBackupIds
filter to return only the backups created from a source backup. ThesourceBackupID
of a source backup is returned by the CopyBackupToRegion operation.Use the
clusterIds
filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).Use the
states
filter to return only backups that match the specified state.Use the
neverExpires
filter to return backups filtered by the value in theneverExpires
parameter.True
returns all backups exempt from the backup retention policy.False
returns all backups with a backup retention policy defined at the cluster.- Parameters:
filters
- One or more filters to limit the items returned in the response.Use the
backupIds
filter to return only the specified backups. Specify backups by their backup identifier (ID).Use the
sourceBackupIds
filter to return only the backups created from a source backup. ThesourceBackupID
of a source backup is returned by the CopyBackupToRegion operation.Use the
clusterIds
filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).Use the
states
filter to return only backups that match the specified state.Use the
neverExpires
filter to return backups filtered by the value in theneverExpires
parameter.True
returns all backups exempt from the backup retention policy.False
returns all backups with a backup retention policy defined at the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortAscending
Designates whether or not to sort the return backups by ascending chronological order of generation.
- Parameters:
sortAscending
- Designates whether or not to sort the return backups by ascending chronological order of generation.- 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.
-