/*
* Copyright 2012-2017 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;
/**
* <p/>
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstances" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBInstancesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* <p>
* The user-supplied instance identifier. If this parameter is specified, information from only the specific DB
* instance is returned. This parameter isn't case-sensitive.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must contain from 1 to 63 alphanumeric characters or hyphens
* </p>
* </li>
* <li>
* <p>
* First character must be a letter
* </p>
* </li>
* <li>
* <p>
* Cannot end with a hyphen or contain two consecutive hyphens
* </p>
* </li>
* </ul>
*/
private String dBInstanceIdentifier;
/**
* <p>
* A filter that specifies one or more DB instances to describe.
* </p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB Clusters identified by
* these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
* </ul>
*/
private com.amazonaws.internal.SdkInternalList<Filter> filters;
/**
* <p>
* The maximum number of records to include in the response. If more records exist than the specified
* <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved.
* </p>
* <p>
* Default: 100
* </p>
* <p>
* Constraints: Minimum 20, maximum 100.
* </p>
*/
private Integer maxRecords;
/**
* <p>
* An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter
* is specified, the response includes only records beyond the marker, up to the value specified by
* <code>MaxRecords</code>.
* </p>
*/
private String marker;
/**
* <p>
* The user-supplied instance identifier. If this parameter is specified, information from only the specific DB
* instance is returned. This parameter isn't case-sensitive.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must contain from 1 to 63 alphanumeric characters or hyphens
* </p>
* </li>
* <li>
* <p>
* First character must be a letter
* </p>
* </li>
* <li>
* <p>
* Cannot end with a hyphen or contain two consecutive hyphens
* </p>
* </li>
* </ul>
*
* @param dBInstanceIdentifier
* The user-supplied instance identifier. If this parameter is specified, information from only the specific
* DB instance is returned. This parameter isn't case-sensitive.</p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must contain from 1 to 63 alphanumeric characters or hyphens
* </p>
* </li>
* <li>
* <p>
* First character must be a letter
* </p>
* </li>
* <li>
* <p>
* Cannot end with a hyphen or contain two consecutive hyphens
* </p>
* </li>
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
}
/**
* <p>
* The user-supplied instance identifier. If this parameter is specified, information from only the specific DB
* instance is returned. This parameter isn't case-sensitive.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must contain from 1 to 63 alphanumeric characters or hyphens
* </p>
* </li>
* <li>
* <p>
* First character must be a letter
* </p>
* </li>
* <li>
* <p>
* Cannot end with a hyphen or contain two consecutive hyphens
* </p>
* </li>
* </ul>
*
* @return The user-supplied instance identifier. If this parameter is specified, information from only the specific
* DB instance is returned. This parameter isn't case-sensitive.</p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must contain from 1 to 63 alphanumeric characters or hyphens
* </p>
* </li>
* <li>
* <p>
* First character must be a letter
* </p>
* </li>
* <li>
* <p>
* Cannot end with a hyphen or contain two consecutive hyphens
* </p>
* </li>
*/
public String getDBInstanceIdentifier() {
return this.dBInstanceIdentifier;
}
/**
* <p>
* The user-supplied instance identifier. If this parameter is specified, information from only the specific DB
* instance is returned. This parameter isn't case-sensitive.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must contain from 1 to 63 alphanumeric characters or hyphens
* </p>
* </li>
* <li>
* <p>
* First character must be a letter
* </p>
* </li>
* <li>
* <p>
* Cannot end with a hyphen or contain two consecutive hyphens
* </p>
* </li>
* </ul>
*
* @param dBInstanceIdentifier
* The user-supplied instance identifier. If this parameter is specified, information from only the specific
* DB instance is returned. This parameter isn't case-sensitive.</p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must contain from 1 to 63 alphanumeric characters or hyphens
* </p>
* </li>
* <li>
* <p>
* First character must be a letter
* </p>
* </li>
* <li>
* <p>
* Cannot end with a hyphen or contain two consecutive hyphens
* </p>
* </li>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstancesRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
setDBInstanceIdentifier(dBInstanceIdentifier);
return this;
}
/**
* <p>
* A filter that specifies one or more DB instances to describe.
* </p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB Clusters identified by
* these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
* </ul>
*
* @return A filter that specifies one or more DB instances to describe.</p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
* The results list will only include information about the DB instances associated with the DB Clusters
* identified by these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs). The results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
*/
public java.util.List<Filter> getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList<Filter>();
}
return filters;
}
/**
* <p>
* A filter that specifies one or more DB instances to describe.
* </p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB Clusters identified by
* these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
* </ul>
*
* @param filters
* A filter that specifies one or more DB instances to describe.</p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
* The results list will only include information about the DB instances associated with the DB Clusters
* identified by these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs). The results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
*/
public void setFilters(java.util.Collection<Filter> filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList<Filter>(filters);
}
/**
* <p>
* A filter that specifies one or more DB instances to describe.
* </p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB Clusters identified by
* these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
* </ul>
* <p>
* <b>NOTE:</b> 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.
* </p>
*
* @param filters
* A filter that specifies one or more DB instances to describe.</p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
* The results list will only include information about the DB instances associated with the DB Clusters
* identified by these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs). The results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
* @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 com.amazonaws.internal.SdkInternalList<Filter>(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
* <p>
* A filter that specifies one or more DB instances to describe.
* </p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB Clusters identified by
* these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
* </ul>
*
* @param filters
* A filter that specifies one or more DB instances to describe.</p>
* <p>
* Supported filters:
* </p>
* <ul>
* <li>
* <p>
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
* The results list will only include information about the DB instances associated with the DB Clusters
* identified by these ARNs.
* </p>
* </li>
* <li>
* <p>
* <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs). The results list will only include information about the DB instances identified by these ARNs.
* </p>
* </li>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstancesRequest withFilters(java.util.Collection<Filter> filters) {
setFilters(filters);
return this;
}
/**
* <p>
* The maximum number of records to include in the response. If more records exist than the specified
* <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved.
* </p>
* <p>
* Default: 100
* </p>
* <p>
* Constraints: Minimum 20, maximum 100.
* </p>
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved. </p>
* <p>
* Default: 100
* </p>
* <p>
* Constraints: Minimum 20, maximum 100.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* <p>
* The maximum number of records to include in the response. If more records exist than the specified
* <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved.
* </p>
* <p>
* Default: 100
* </p>
* <p>
* Constraints: Minimum 20, maximum 100.
* </p>
*
* @return The maximum number of records to include in the response. If more records exist than the specified
* <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved. </p>
* <p>
* Default: 100
* </p>
* <p>
* Constraints: Minimum 20, maximum 100.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
* <p>
* The maximum number of records to include in the response. If more records exist than the specified
* <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved.
* </p>
* <p>
* Default: 100
* </p>
* <p>
* Constraints: Minimum 20, maximum 100.
* </p>
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved. </p>
* <p>
* Default: 100
* </p>
* <p>
* 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;
}
/**
* <p>
* An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter
* is specified, the response includes only records beyond the marker, up to the value specified by
* <code>MaxRecords</code>.
* </p>
*
* @param marker
* An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* <code>MaxRecords</code>.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* <p>
* An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter
* is specified, the response includes only records beyond the marker, up to the value specified by
* <code>MaxRecords</code>.
* </p>
*
* @return An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified
* by <code>MaxRecords</code>.
*/
public String getMarker() {
return this.marker;
}
/**
* <p>
* An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter
* is specified, the response includes only records beyond the marker, up to the value specified by
* <code>MaxRecords</code>.
* </p>
*
* @param marker
* An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* <code>MaxRecords</code>.
* @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; useful for testing and debugging.
*
* @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();
}
}