/*
* 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;
/**
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParameters" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBParametersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* <p>
* The name of a specific DB parameter group to return details for.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 dBParameterGroupName;
/**
* <p>
* The parameter types to return.
* </p>
* <p>
* Default: All parameter types returned
* </p>
* <p>
* Valid Values: <code>user | system | engine-default</code>
* </p>
*/
private String source;
/**
* <p>
* This parameter is not currently supported.
* </p>
*/
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>DescribeDBParameters</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;
/**
* Default constructor for DescribeDBParametersRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public DescribeDBParametersRequest() {
}
/**
* Constructs a new DescribeDBParametersRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param dBParameterGroupName
* The name of a specific DB parameter group to return details for.</p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 DescribeDBParametersRequest(String dBParameterGroupName) {
setDBParameterGroupName(dBParameterGroupName);
}
/**
* <p>
* The name of a specific DB parameter group to return details for.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 dBParameterGroupName
* The name of a specific DB parameter group to return details for.</p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 setDBParameterGroupName(String dBParameterGroupName) {
this.dBParameterGroupName = dBParameterGroupName;
}
/**
* <p>
* The name of a specific DB parameter group to return details for.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 name of a specific DB parameter group to return details for.</p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 getDBParameterGroupName() {
return this.dBParameterGroupName;
}
/**
* <p>
* The name of a specific DB parameter group to return details for.
* </p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 dBParameterGroupName
* The name of a specific DB parameter group to return details for.</p>
* <p>
* Constraints:
* </p>
* <ul>
* <li>
* <p>
* Must be 1 to 255 alphanumeric characters
* </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 DescribeDBParametersRequest withDBParameterGroupName(String dBParameterGroupName) {
setDBParameterGroupName(dBParameterGroupName);
return this;
}
/**
* <p>
* The parameter types to return.
* </p>
* <p>
* Default: All parameter types returned
* </p>
* <p>
* Valid Values: <code>user | system | engine-default</code>
* </p>
*
* @param source
* The parameter types to return.</p>
* <p>
* Default: All parameter types returned
* </p>
* <p>
* Valid Values: <code>user | system | engine-default</code>
*/
public void setSource(String source) {
this.source = source;
}
/**
* <p>
* The parameter types to return.
* </p>
* <p>
* Default: All parameter types returned
* </p>
* <p>
* Valid Values: <code>user | system | engine-default</code>
* </p>
*
* @return The parameter types to return.</p>
* <p>
* Default: All parameter types returned
* </p>
* <p>
* Valid Values: <code>user | system | engine-default</code>
*/
public String getSource() {
return this.source;
}
/**
* <p>
* The parameter types to return.
* </p>
* <p>
* Default: All parameter types returned
* </p>
* <p>
* Valid Values: <code>user | system | engine-default</code>
* </p>
*
* @param source
* The parameter types to return.</p>
* <p>
* Default: All parameter types returned
* </p>
* <p>
* Valid Values: <code>user | system | engine-default</code>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBParametersRequest withSource(String source) {
setSource(source);
return this;
}
/**
* <p>
* This parameter is not currently supported.
* </p>
*
* @return This parameter is not currently supported.
*/
public java.util.List<Filter> getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList<Filter>();
}
return filters;
}
/**
* <p>
* This parameter is not currently supported.
* </p>
*
* @param filters
* This parameter is not currently supported.
*/
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>
* This parameter is not currently supported.
* </p>
* <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
* This parameter is not currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBParametersRequest 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>
* This parameter is not currently supported.
* </p>
*
* @param filters
* This parameter is not currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBParametersRequest 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 DescribeDBParametersRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
* <p>
* An optional pagination token provided by a previous <code>DescribeDBParameters</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>DescribeDBParameters</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>DescribeDBParameters</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>DescribeDBParameters</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>DescribeDBParameters</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>DescribeDBParameters</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 DescribeDBParametersRequest 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 (getDBParameterGroupName() != null)
sb.append("DBParameterGroupName: ").append(getDBParameterGroupName()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).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 DescribeDBParametersRequest == false)
return false;
DescribeDBParametersRequest other = (DescribeDBParametersRequest) obj;
if (other.getDBParameterGroupName() == null ^ this.getDBParameterGroupName() == null)
return false;
if (other.getDBParameterGroupName() != null && other.getDBParameterGroupName().equals(this.getDBParameterGroupName()) == false)
return false;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == 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 + ((getDBParameterGroupName() == null) ? 0 : getDBParameterGroupName().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().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 DescribeDBParametersRequest clone() {
return (DescribeDBParametersRequest) super.clone();
}
}