/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.rds.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeDBClustersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** 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. *
** 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.
*
* 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. *
*/ private Integer maxRecords; /** *
* 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
.
*
* Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. *
*/ private Boolean includeShared; /** ** 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. *
** 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. *
** 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. *
** 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.
*
* 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.
*
* 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 * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. *
* * @param 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.
*
* 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.
*
* 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. *
* * @param 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 setMaxRecords(Integer maxRecords) { this.maxRecords = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDBClustersRequest withMaxRecords(Integer maxRecords) { setMaxRecords(maxRecords); return this; } /** *
* 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 void setMarker(String marker) {
this.marker = 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
.
*
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() {
return this.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
.
*
DescribeDBClusters
request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBClustersRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
* * Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. *
* * @param includeShared * Specifies whether the output includes information about clusters shared from other Amazon Web Services * accounts. */ public void setIncludeShared(Boolean includeShared) { this.includeShared = includeShared; } /** ** Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. *
* * @return Specifies whether the output includes information about clusters shared from other Amazon Web Services * accounts. */ public Boolean getIncludeShared() { return this.includeShared; } /** ** Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. *
* * @param includeShared * Specifies whether the output includes information about clusters shared from other Amazon Web Services * accounts. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDBClustersRequest withIncludeShared(Boolean includeShared) { setIncludeShared(includeShared); return this; } /** ** Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. *
* * @return Specifies whether the output includes information about clusters shared from other Amazon Web Services * accounts. */ public Boolean isIncludeShared() { return this.includeShared; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getDBClusterIdentifier() != null) sb.append("DBClusterIdentifier: ").append(getDBClusterIdentifier()).append(","); if (getFilters() != null) sb.append("Filters: ").append(getFilters()).append(","); if (getMaxRecords() != null) sb.append("MaxRecords: ").append(getMaxRecords()).append(","); if (getMarker() != null) sb.append("Marker: ").append(getMarker()).append(","); if (getIncludeShared() != null) sb.append("IncludeShared: ").append(getIncludeShared()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeDBClustersRequest == false) return false; DescribeDBClustersRequest other = (DescribeDBClustersRequest) obj; if (other.getDBClusterIdentifier() == null ^ this.getDBClusterIdentifier() == null) return false; if (other.getDBClusterIdentifier() != null && other.getDBClusterIdentifier().equals(this.getDBClusterIdentifier()) == false) return false; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; if (other.getMaxRecords() == null ^ this.getMaxRecords() == null) return false; if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false) return false; if (other.getMarker() == null ^ this.getMarker() == null) return false; if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false) return false; if (other.getIncludeShared() == null ^ this.getIncludeShared() == null) return false; if (other.getIncludeShared() != null && other.getIncludeShared().equals(this.getIncludeShared()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDBClusterIdentifier() == null) ? 0 : getDBClusterIdentifier().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode()); hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); hashCode = prime * hashCode + ((getIncludeShared() == null) ? 0 : getIncludeShared().hashCode()); return hashCode; } @Override public DescribeDBClustersRequest clone() { return (DescribeDBClustersRequest) super.clone(); } }