Package 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:

SdkPojo, ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeClustersRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeClustersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeClustersRequest.Builder>	serializableBuilderClass()
DescribeClustersRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

Specified by:

toBuilder in class CloudHsmV2Request

builder

public static DescribeClustersRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo