@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeDBClustersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeDBClustersRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeDBClustersRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getDBClusterIdentifier()
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster.
|
List<Filter> |
getFilters()
A filter that specifies one or more DB clusters to describe.
|
Boolean |
getIncludeShared()
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
|
String |
getMarker()
An optional pagination token provided by a previous
DescribeDBClusters request. |
Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
int |
hashCode() |
Boolean |
isIncludeShared()
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster.
|
void |
setFilters(Collection<Filter> filters)
A filter that specifies one or more DB clusters to describe.
|
void |
setIncludeShared(Boolean includeShared)
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
|
void |
setMarker(String marker)
An optional pagination token provided by a previous
DescribeDBClusters request. |
void |
setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
String |
toString()
Returns a string representation of this object.
|
DescribeDBClustersRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster.
|
DescribeDBClustersRequest |
withFilters(Collection<Filter> filters)
A filter that specifies one or more DB clusters to describe.
|
DescribeDBClustersRequest |
withFilters(Filter... filters)
A filter that specifies one or more DB clusters to describe.
|
DescribeDBClustersRequest |
withIncludeShared(Boolean includeShared)
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
|
DescribeDBClustersRequest |
withMarker(String marker)
An optional pagination token provided by a previous
DescribeDBClusters request. |
DescribeDBClustersRequest |
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDBClusterIdentifier(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.
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.
public String getDBClusterIdentifier()
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.
Constraints:
If supplied, must match an existing DB cluster identifier.
public DescribeDBClustersRequest withDBClusterIdentifier(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.
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.
public List<Filter> getFilters()
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.
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.
public void setFilters(Collection<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.
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.
public DescribeDBClustersRequest withFilters(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.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
or withFilters(java.util.Collection)
if you want to override
the existing values.
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.
public DescribeDBClustersRequest withFilters(Collection<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.
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.
public void setMaxRecords(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
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
public Integer getMaxRecords()
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
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
public DescribeDBClustersRequest withMaxRecords(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
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
public void setMarker(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
.
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
.public String getMarker()
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
.
DescribeDBClusters
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified
by MaxRecords
.public DescribeDBClustersRequest withMarker(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
.
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
.public void setIncludeShared(Boolean includeShared)
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
includeShared
- Specifies whether the output includes information about clusters shared from other Amazon Web Services
accounts.public Boolean getIncludeShared()
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
public DescribeDBClustersRequest withIncludeShared(Boolean includeShared)
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
includeShared
- Specifies whether the output includes information about clusters shared from other Amazon Web Services
accounts.public Boolean isIncludeShared()
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
public String toString()
toString
in class Object
Object.toString()
public DescribeDBClustersRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()