com.amazonaws.services.rds.model.DescribeDBInstancesRequest Maven / Gradle / Ivy
/*
* Copyright 2011-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class DescribeDBInstancesRequest extends
com.amazonaws.AmazonWebServiceRequest implements Serializable,
Cloneable {
/**
*
* 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.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*/
private String dBInstanceIdentifier;
/**
*
* This parameter is not currently supported.
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* 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 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
* DescribeDBInstances
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-supplied instance identifier. If this parameter is specified,
* information from only the specific DB instance is returned. This
* parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @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.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = 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.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @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.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public String getDBInstanceIdentifier() {
return this.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.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @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.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBInstancesRequest withDBInstanceIdentifier(
String dBInstanceIdentifier) {
setDBInstanceIdentifier(dBInstanceIdentifier);
return this;
}
/**
*
* This parameter is not currently supported.
*
*
* @return This parameter is not currently supported.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* This parameter is not currently supported.
*
*
* @param filters
* This parameter is not currently supported.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
filters);
}
/**
*
* This parameter is not currently supported.
*
*
* 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
* This parameter is not currently supported.
* @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(
filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* This parameter is not currently supported.
*
*
* @param filters
* This parameter is not currently supported.
* @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 called a 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 called a 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 called a 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 called a 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 called a 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 called a 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
* DescribeDBInstances
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
* DescribeDBInstances
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
* DescribeDBInstances
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
* DescribeDBInstances
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
* DescribeDBInstances
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
* DescribeDBInstances
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; 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: " + getDBInstanceIdentifier()
+ ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters() + ",");
if (getMaxRecords() != null)
sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getMarker() != null)
sb.append("Marker: " + 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();
}
}