com.amazonaws.services.redshift.model.DescribeClusterParametersRequest 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.redshift.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.redshift.AmazonRedshift#describeClusterParameters(DescribeClusterParametersRequest) DescribeClusterParameters operation}.
*
* Returns a detailed list of parameters contained within the specified
* Amazon Redshift parameter group. For each parameter the response
* includes information such as parameter name, description, data type,
* value, whether the parameter value is modifiable, and so on.
*
*
* You can specify source filter to retrieve parameters of only
* specific type. For example, to retrieve parameters that were modified
* by a user action such as from ModifyClusterParameterGroup, you can
* specify source equal to user .
*
*
* For more information about managing parameter groups, go to
* Amazon Redshift Parameter Groups
* in the Amazon Redshift Management Guide .
*
*
* @see com.amazonaws.services.redshift.AmazonRedshift#describeClusterParameters(DescribeClusterParametersRequest)
*/
public class DescribeClusterParametersRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of a cluster parameter group for which to return details.
*/
private String parameterGroupName;
/**
* The parameter types to return. Specify user to show
* parameters that are different form the default. Similarly, specify
* engine-default to show parameters that are the same as
* the default parameter group. Default: All parameter types returned.
*
Valid Values: user | engine-default
*/
private String source;
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*/
private Integer maxRecords;
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a
* DescribeClusterParameters request exceed the value specified in
* MaxRecords, AWS returns a value in the
* Marker field of the response. You can retrieve the next
* set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*/
private String marker;
/**
* The name of a cluster parameter group for which to return details.
*
* @return The name of a cluster parameter group for which to return details.
*/
public String getParameterGroupName() {
return parameterGroupName;
}
/**
* The name of a cluster parameter group for which to return details.
*
* @param parameterGroupName The name of a cluster parameter group for which to return details.
*/
public void setParameterGroupName(String parameterGroupName) {
this.parameterGroupName = parameterGroupName;
}
/**
* The name of a cluster parameter group for which to return details.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param parameterGroupName The name of a cluster parameter group for which to return details.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeClusterParametersRequest withParameterGroupName(String parameterGroupName) {
this.parameterGroupName = parameterGroupName;
return this;
}
/**
* The parameter types to return. Specify user to show
* parameters that are different form the default. Similarly, specify
* engine-default to show parameters that are the same as
* the default parameter group.
Default: All parameter types returned.
*
Valid Values: user | engine-default
*
* @return The parameter types to return. Specify user to show
* parameters that are different form the default. Similarly, specify
* engine-default to show parameters that are the same as
* the default parameter group.
Default: All parameter types returned.
*
Valid Values: user | engine-default
*/
public String getSource() {
return source;
}
/**
* The parameter types to return. Specify user to show
* parameters that are different form the default. Similarly, specify
* engine-default to show parameters that are the same as
* the default parameter group.
Default: All parameter types returned.
*
Valid Values: user | engine-default
*
* @param source The parameter types to return. Specify user to show
* parameters that are different form the default. Similarly, specify
* engine-default to show parameters that are the same as
* the default parameter group.
Default: All parameter types returned.
*
Valid Values: user | engine-default
*/
public void setSource(String source) {
this.source = source;
}
/**
* The parameter types to return. Specify user to show
* parameters that are different form the default. Similarly, specify
* engine-default to show parameters that are the same as
* the default parameter group.
Default: All parameter types returned.
*
Valid Values: user | engine-default
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param source The parameter types to return. Specify user to show
* parameters that are different form the default. Similarly, specify
* engine-default to show parameters that are the same as
* the default parameter group.
Default: All parameter types returned.
*
Valid Values: user | engine-default
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeClusterParametersRequest withSource(String source) {
this.source = source;
return this;
}
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*
* @return The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*
* @param maxRecords The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
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 response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeClusterParametersRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a
* DescribeClusterParameters request exceed the value specified in
* MaxRecords, AWS returns a value in the
* Marker field of the response. You can retrieve the next
* set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*
* @return An optional parameter that specifies the starting point to return a
* set of response records. When the results of a
* DescribeClusterParameters request exceed the value specified in
* MaxRecords, AWS returns a value in the
* Marker field of the response. You can retrieve the next
* set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*/
public String getMarker() {
return marker;
}
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a
* DescribeClusterParameters request exceed the value specified in
* MaxRecords, AWS returns a value in the
* Marker field of the response. You can retrieve the next
* set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*
* @param marker An optional parameter that specifies the starting point to return a
* set of response records. When the results of a
* DescribeClusterParameters request exceed the value specified in
* MaxRecords, AWS returns a value in the
* Marker field of the response. You can retrieve the next
* set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a
* DescribeClusterParameters request exceed the value specified in
* MaxRecords, AWS returns a value in the
* Marker field of the response. You can retrieve the next
* set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param marker An optional parameter that specifies the starting point to return a
* set of response records. When the results of a
* DescribeClusterParameters request exceed the value specified in
* MaxRecords, AWS returns a value in the
* Marker field of the response. You can retrieve the next
* set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeClusterParametersRequest 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 (getParameterGroupName() != null) sb.append("ParameterGroupName: " + getParameterGroupName() + ",");
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 + ((getParameterGroupName() == null) ? 0 : getParameterGroupName().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 DescribeClusterParametersRequest == false) return false;
DescribeClusterParametersRequest other = (DescribeClusterParametersRequest)obj;
if (other.getParameterGroupName() == null ^ this.getParameterGroupName() == null) return false;
if (other.getParameterGroupName() != null && other.getParameterGroupName().equals(this.getParameterGroupName()) == 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;
}
}