All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBClustersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  DescribeDBClustersRequest ()

• Method Summary

  All Methods

  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.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    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

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • DescribeDBClustersRequest

    public DescribeDBClustersRequest()

• Method Detail

  • setDBClusterIdentifier

    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.

    Parameters:

    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.

  • getDBClusterIdentifier

    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.

    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.

  • withDBClusterIdentifier

    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.

    Parameters:

    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:

    Returns a reference to this object so that method calls can be chained together.

  • getFilters

    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.

    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.

  • setFilters

    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.

    Parameters:

    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.

  • withFilters

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withFilters

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setMaxRecords

    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

    Parameters:

    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

  • getMaxRecords

    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

    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

  • withMaxRecords

    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

    Parameters:

    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:

    Returns a reference to this object so that method calls can be chained together.

  • setMarker

    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.

    Parameters:

    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.

  • getMarker

    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.

    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.

  • withMarker

    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.

    Parameters:

    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:

    Returns a reference to this object so that method calls can be chained together.

  • setIncludeShared

    public void setIncludeShared(Boolean includeShared)

    Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

    Parameters:

    includeShared - Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

  • getIncludeShared

    public Boolean getIncludeShared()

    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.

  • withIncludeShared

    public DescribeDBClustersRequest withIncludeShared(Boolean includeShared)

    Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

    Parameters:

    includeShared - Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isIncludeShared

    public Boolean isIncludeShared()

    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.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public DescribeDBClustersRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()