com.amazonaws.services.rds.model.DescribeDBParametersRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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;
/**
* Container for the parameters to the {@link com.amazonaws.services.rds.AmazonRDS#describeDBParameters(DescribeDBParametersRequest) DescribeDBParameters operation}.
*
* Returns the detailed parameter list for a particular DB parameter
* group.
*
*
* @see com.amazonaws.services.rds.AmazonRDS#describeDBParameters(DescribeDBParametersRequest)
*/
public class DescribeDBParametersRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of a specific DB parameter group to return details for.
* Constraints:
- Must be 1 to 255 alphanumeric characters
* - First character must be a letter
- Cannot end with a hyphen
* or contain two consecutive hyphens
*/
private String dBParameterGroupName;
/**
* The parameter types to return. Default: All parameter types
* returned
Valid Values: user | system | engine-default
*/
private String source;
/**
* 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 may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*/
private Integer maxRecords;
/**
* An optional pagination token provided by a previous
* DescribeDBParameters request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
private String marker;
/**
* Default constructor for a new DescribeDBParametersRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this 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.
Constraints:
- Must be 1 to 255
* alphanumeric characters
- First character must be a letter
* - Cannot end with a hyphen or contain two consecutive hyphens
*
*/
public DescribeDBParametersRequest(String dBParameterGroupName) {
setDBParameterGroupName(dBParameterGroupName);
}
/**
* The name of a specific DB parameter group to return details for.
* Constraints:
- Must be 1 to 255 alphanumeric characters
* - First character must be a letter
- Cannot end with a hyphen
* or contain two consecutive hyphens
*
* @return The name of a specific DB parameter group to return details for.
* Constraints:
- Must be 1 to 255 alphanumeric characters
* - First character must be a letter
- Cannot end with a hyphen
* or contain two consecutive hyphens
*/
public String getDBParameterGroupName() {
return dBParameterGroupName;
}
/**
* The name of a specific DB parameter group to return details for.
* Constraints:
- Must be 1 to 255 alphanumeric characters
* - First character must be a letter
- Cannot end with a hyphen
* or contain two consecutive hyphens
*
* @param dBParameterGroupName The name of a specific DB parameter group to return details for.
* Constraints:
- Must be 1 to 255 alphanumeric characters
* - First character must be a letter
- Cannot end with a hyphen
* or contain two consecutive hyphens
*/
public void setDBParameterGroupName(String dBParameterGroupName) {
this.dBParameterGroupName = dBParameterGroupName;
}
/**
* The name of a specific DB parameter group to return details for.
* Constraints:
- Must be 1 to 255 alphanumeric characters
* - First character must be a letter
- Cannot end with a hyphen
* or contain two consecutive hyphens
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dBParameterGroupName The name of a specific DB parameter group to return details for.
*
Constraints:
- Must be 1 to 255 alphanumeric characters
* - First character must be a letter
- Cannot end with a hyphen
* or contain two consecutive hyphens
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBParametersRequest withDBParameterGroupName(String dBParameterGroupName) {
this.dBParameterGroupName = dBParameterGroupName;
return this;
}
/**
* The parameter types to return. Default: All parameter types
* returned
Valid Values: user | system | engine-default
*
* @return The parameter types to return.
Default: All parameter types
* returned
Valid Values: user | system | engine-default
*/
public String getSource() {
return source;
}
/**
* The parameter types to return.
Default: All parameter types
* returned
Valid Values: user | system | engine-default
*
* @param source The parameter types to return.
Default: All parameter types
* returned
Valid Values: user | system | engine-default
*/
public void setSource(String source) {
this.source = source;
}
/**
* The parameter types to return.
Default: All parameter types
* returned
Valid Values: user | system | engine-default
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param source The parameter types to return.
Default: All parameter types
* returned
Valid Values: user | system | engine-default
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBParametersRequest withSource(String source) {
this.source = source;
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 may 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 may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*/
public Integer getMaxRecords() {
return 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 may 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 may 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 may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*
* Returns a reference to this object so that method calls can be chained together.
*
* @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 may be retrieved.
Default: 100
*
Constraints: minimum 20, maximum 100
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBParametersRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* An optional pagination token provided by a previous
* DescribeDBParameters 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
* DescribeDBParameters 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 marker;
}
/**
* An optional pagination token provided by a previous
* DescribeDBParameters 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
* DescribeDBParameters 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
* DescribeDBParameters request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param marker An optional pagination token provided by a previous
* DescribeDBParameters request. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBParametersRequest withMarker(String marker) {
this.marker = 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: " + getDBParameterGroupName() + ",");
if (getSource() != null) sb.append("Source: " + getSource() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() );
sb.append("}");
return sb.toString();
}
@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 + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@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.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;
}
}