software.amazon.awssdk.services.cloudhsmv2.model

Class DescribeClustersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudhsmv2.model.CloudHSMV2Request

software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest

All Implemented Interfaces:

ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeClustersRequest
extends CloudHSMV2Request
implements ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeClustersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeClustersRequest.Builder	builder()
boolean	equals(Object obj)
Map<String,List<String>>	filters() One or more filters to limit the items returned in the response.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of clusters to return in the response.
String	nextToken() The NextToken value that you received in the previous response.
static Class<? extends DescribeClustersRequest.Builder>	serializableBuilderClass()
DescribeClustersRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

filters

public Map<String,List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

nextToken

public String nextToken()

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

Returns:

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

maxResults

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

Returns:

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.

toBuilder

public DescribeClustersRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

Specified by:

toBuilder in class CloudHSMV2Request

Returns:

a builder for type T

builder

public static DescribeClustersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeClustersRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value