com.amazonaws.services.docdb.model.DescribeDBInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-docdb Show documentation
/*
* Copyright 2019-2024 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.docdb.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input to DescribeDBInstances.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBInstancesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The user-provided instance identifier. If this parameter is specified, information from only the specific
* instance is returned. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* If provided, must match the identifier of an existing DBInstance.
*
*
*
*/
private String dBInstanceIdentifier;
/**
*
* A filter that specifies one or more instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results
* list includes only the information about the instances that are associated with the clusters that are identified
* by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the
* information about the instances that are identified by these ARNs.
*
*
*
*/
private java.util.List filters;
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*/
private Integer maxRecords;
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords.
*
*/
private String marker;
/**
*
* The user-provided instance identifier. If this parameter is specified, information from only the specific
* instance is returned. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* If provided, must match the identifier of an existing DBInstance.
*
*
*
*
* @param dBInstanceIdentifier
* The user-provided instance identifier. If this parameter is specified, information from only the specific
* instance is returned. This parameter isn't case sensitive.
*
* Constraints:
*
*
* -
*
* If provided, must match the identifier of an existing DBInstance.
*
*
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
}
/**
*
* The user-provided instance identifier. If this parameter is specified, information from only the specific
* instance is returned. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* If provided, must match the identifier of an existing DBInstance.
*
*
*
*
* @return The user-provided instance identifier. If this parameter is specified, information from only the specific
* instance is returned. This parameter isn't case sensitive.
*
* Constraints:
*
*
* -
*
* If provided, must match the identifier of an existing DBInstance.
*
*
*/
public String getDBInstanceIdentifier() {
return this.dBInstanceIdentifier;
}
/**
*
* The user-provided instance identifier. If this parameter is specified, information from only the specific
* instance is returned. This parameter isn't case sensitive.
*
*
* Constraints:
*
*
* -
*
* If provided, must match the identifier of an existing DBInstance.
*
*
*
*
* @param dBInstanceIdentifier
* The user-provided instance identifier. If this parameter is specified, information from only the specific
* instance is returned. This parameter isn't case sensitive.
*
* Constraints:
*
*
* -
*
* If provided, must match the identifier of an existing DBInstance.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstancesRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
setDBInstanceIdentifier(dBInstanceIdentifier);
return this;
}
/**
*
* A filter that specifies one or more instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results
* list includes only the information about the instances that are associated with the clusters that are identified
* by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the
* information about the instances that are identified by these ARNs.
*
*
*
*
* @return A filter that specifies one or more instances to describe.
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The
* results list includes only the information about the instances that are associated with the clusters that
* are identified by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes
* only the information about the instances that are identified by these ARNs.
*
*
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* A filter that specifies one or more instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results
* list includes only the information about the instances that are associated with the clusters that are identified
* by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the
* information about the instances that are identified by these ARNs.
*
*
*
*
* @param filters
* A filter that specifies one or more instances to describe.
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The
* results list includes only the information about the instances that are associated with the clusters that
* are identified by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes
* only the information about the instances that are identified by these ARNs.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* A filter that specifies one or more instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results
* list includes only the information about the instances that are associated with the clusters that are identified
* by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the
* information about the instances that are identified by these ARNs.
*
*
*
*
* 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 instances to describe.
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The
* results list includes only the information about the instances that are associated with the clusters that
* are identified by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes
* only the information about the instances that are identified by these ARNs.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstancesRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* A filter that specifies one or more instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results
* list includes only the information about the instances that are associated with the clusters that are identified
* by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the
* information about the instances that are identified by these ARNs.
*
*
*
*
* @param filters
* A filter that specifies one or more instances to describe.
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The
* results list includes only the information about the instances that are associated with the clusters that
* are identified by these ARNs.
*
*
* -
*
* db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes
* only the information about the instances that are identified by these ARNs.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstancesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* 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 (marker) is included in the response so that the
* remaining results can be retrieved.
*
* 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 (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* 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 (marker) is included in the response so that the
* remaining results can be retrieved.
*
* 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 (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* 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 (marker) is included in the response so that the
* remaining results can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstancesRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords.
*
*
* @param marker
* An optional pagination token provided by a previous 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 request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords.
*
*
* @return An optional pagination token provided by a previous 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 request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords.
*
*
* @param marker
* An optional pagination token provided by a previous 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 DescribeDBInstancesRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
* 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 (getDBInstanceIdentifier() != null)
sb.append("DBInstanceIdentifier: ").append(getDBInstanceIdentifier()).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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDBInstancesRequest == false)
return false;
DescribeDBInstancesRequest other = (DescribeDBInstancesRequest) obj;
if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null)
return false;
if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().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());
return hashCode;
}
@Override
public DescribeDBInstancesRequest clone() {
return (DescribeDBInstancesRequest) super.clone();
}
}