software.amazon.awssdk.services.docdb.model

Class DescribeGlobalClustersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGlobalClustersRequest.Builder,DescribeGlobalClustersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeGlobalClustersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeGlobalClustersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() A filter that specifies one or more global DB clusters to describe.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalClusterIdentifier() The user-supplied cluster identifier.
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
String	marker() An optional pagination token provided by a previous DescribeGlobalClusters request.
Integer	maxRecords() The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeGlobalClustersRequest.Builder>	serializableBuilderClass()
DescribeGlobalClustersRequest.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

globalClusterIdentifier

public final String globalClusterIdentifier()

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

Returns:

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

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 List<Filter> filters()

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

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:

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

maxRecords

public final Integer maxRecords()

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

marker

public final String marker()

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

toBuilder

public DescribeGlobalClustersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGlobalClustersRequest.Builder,DescribeGlobalClustersRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static DescribeGlobalClustersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeGlobalClustersRequest.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