software.amazon.awssdk.services.cloudhsmv2.model

Interface DescribeClustersRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeClustersRequest

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

Method Summary

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

filters

DescribeClustersRequest.Builder filters(Map<String,? extends Collection<String>> filters)

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

Parameters:

filters - One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

Returns:

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

nextToken

DescribeClustersRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

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

maxResults

DescribeClustersRequest.Builder maxResults(Integer maxResults)

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

Parameters:

maxResults - The maximum number of clusters to return in the response. When there are more clusters 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.

requestOverrideConfig

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

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