software.amazon.awssdk.services.cloudhsmv2.model

Interface DescribeBackupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CloudHSMV2Request.Builder, CopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>, SdkBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>, SdkRequest.Builder

Enclosing class:

DescribeBackupsRequest

public static interface DescribeBackupsRequest.Builder
extends CloudHSMV2Request.Builder, CopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeBackupsRequest.Builder	filters(Map<String,? extends Collection<String>> filters) One or more filters to limit the items returned in the response.
DescribeBackupsRequest.Builder	maxResults(Integer maxResults) The maximum number of backups to return in the response.
DescribeBackupsRequest.Builder	nextToken(String nextToken) The NextToken value that you received in the previous response.
DescribeBackupsRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeBackupsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.cloudhsmv2.model.CloudHSMV2Request.Builder

build

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

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

nextToken

DescribeBackupsRequest.Builder nextToken(String nextToken)

The NextToken value that you received in the previous response. Use this value to get more backups.

Parameters:

nextToken - The NextToken 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

DescribeBackupsRequest.Builder maxResults(Integer 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 a NextToken value.

Returns:

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

filters

DescribeBackupsRequest.Builder filters(Map<String,? extends Collection<String>> 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 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.

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

Returns:

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

requestOverrideConfig

DescribeBackupsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeBackupsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.