java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeDbClustersRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeDbClustersRequest.Builder`	`builder()`
`String`	`dbClusterIdentifier()`	The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()`	A filter that specifies one or more DB clusters to describe.
`<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()`
`Boolean`	`includeShared()`	Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
`String`	`marker()`	An optional pagination token provided by a previous `DescribeDBClusters` request.
`Integer`	`maxRecords()`	The maximum number of records to include in the response.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeDbClustersRequest.Builder>`	`serializableBuilderClass()`
`DescribeDbClustersRequest.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
  - dbClusterIdentifier
```
public final String dbClusterIdentifier()
```
    The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
    
    Constraints:
    
    If supplied, must match an existing DB cluster identifier.
    Returns:
    
    The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
    
    Constraints:
    
    If supplied, must match an existing DB cluster identifier.
  - 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 DB clusters to describe.
    
    Supported Filters:
    
    clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
    
    db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
    
    db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
    
    domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
    
    engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
    
    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 DB clusters to describe.
    
    Supported Filters:
    
    clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
    
    db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
    
    db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
    
    domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
    
    engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
  - 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 you can retrieve the remaining results.
    
    Default: 100
    
    Constraints: Minimum 20, maximum 100
    
    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 you can retrieve the remaining results.
    
    Default: 100
    
    Constraints: Minimum 20, maximum 100
  - marker
```
public final String marker()
```
    An optional pagination token provided by a previous DescribeDBClusters 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 DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - includeShared
```
public final Boolean includeShared()
```
    Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
    
    Returns:
    
    Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
  - toBuilder
```
public DescribeDbClustersRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static DescribeDbClustersRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeDbClustersRequest.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

Class DescribeDbClustersRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

dbClusterIdentifier

hasFilters

filters

maxRecords

marker

includeShared

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField