com.amazonaws.services.elasticache.model.DescribeCacheParametersRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-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.elasticache.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 * Represents the input of a DescribeCacheParameters action.
 * 
 */
public class DescribeCacheParametersRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {
    /**
     * 
     * The name of a specific cache parameter group to return details for.
     * 
     */
    private String cacheParameterGroupName;
    /**
     * 
     * The parameter types to return.
     * 
     * 
     * Valid values: user | system |
     * engine-default
     * 
     */
    private String source;
    /**
     * 
     * The maximum number of brecords to include in the response. If more
     * records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for
     * pagination of results from this action. 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 DescribeCacheParametersRequest object. Callers
     * should use the setter or fluent setter (with...) methods to initialize
     * the object after creating it.
     */
    public DescribeCacheParametersRequest() {
    }
    /**
     * Constructs a new DescribeCacheParametersRequest object. Callers should
     * use the setter or fluent setter (with...) methods to initialize any
     * additional object members.
     * 
     * @param cacheParameterGroupName
     *        The name of a specific cache parameter group to return details
     *        for.
     */
    public DescribeCacheParametersRequest(String cacheParameterGroupName) {
        setCacheParameterGroupName(cacheParameterGroupName);
    }
    /**
     * 
     * The name of a specific cache parameter group to return details for.
     * 
     * 
     * @param cacheParameterGroupName
     *        The name of a specific cache parameter group to return details
     *        for.
     */
    public void setCacheParameterGroupName(String cacheParameterGroupName) {
        this.cacheParameterGroupName = cacheParameterGroupName;
    }
    /**
     * 
     * The name of a specific cache parameter group to return details for.
     * 
     * 
     * @return The name of a specific cache parameter group to return details
     *         for.
     */
    public String getCacheParameterGroupName() {
        return this.cacheParameterGroupName;
    }
    /**
     * 
     * The name of a specific cache parameter group to return details for.
     * 
     * 
     * @param cacheParameterGroupName
     *        The name of a specific cache parameter group to return details
     *        for.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeCacheParametersRequest withCacheParameterGroupName(
            String cacheParameterGroupName) {
        setCacheParameterGroupName(cacheParameterGroupName);
        return this;
    }
    /**
     * 
     * The parameter types to return.
     * 
     * 
     * Valid values: user | system |
     * engine-default
     * 
     * 
     * @param source
     *        The parameter types to return.
     *        
     *        Valid values: user | system |
     *        engine-default
     */
    public void setSource(String source) {
        this.source = source;
    }
    /**
     * 
     * The parameter types to return.
     * 
     * 
     * Valid values: user | system |
     * engine-default
     * 
     * 
     * @return The parameter types to return.
     *         
     *         Valid values: user | system |
     *         engine-default
     */
    public String getSource() {
        return this.source;
    }
    /**
     * 
     * The parameter types to return.
     * 
     * 
     * Valid values: user | system |
     * engine-default
     * 
     * 
     * @param source
     *        The parameter types to return.
     *        
     *        Valid values: user | system |
     *        engine-default
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeCacheParametersRequest withSource(String source) {
        setSource(source);
        return this;
    }
    /**
     * 
     * The maximum number of brecords to include in the response. If more
     * records exist than the specified MaxRecords value, 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 brecords to include in the response. If more
     *        records exist than the specified MaxRecords value, 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 brecords to include in the response. If more
     * records exist than the specified MaxRecords value, 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 brecords to include in the response. If
     *         more records exist than the specified MaxRecords
     *         value, 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 brecords to include in the response. If more
     * records exist than the specified MaxRecords value, 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 brecords to include in the response. If more
     *        records exist than the specified MaxRecords value, 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 DescribeCacheParametersRequest withMaxRecords(Integer maxRecords) {
        setMaxRecords(maxRecords);
        return this;
    }
    /**
     * 
     * An optional marker returned from a prior request. Use this marker for
     * pagination of results from this action. If this parameter is specified,
     * the response includes only records beyond the marker, up to the value
     * specified by MaxRecords.
     * 
     * 
     * @param marker
     *        An optional marker returned from a prior request. Use this marker
     *        for pagination of results from this action. 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 marker returned from a prior request. Use this marker for
     * pagination of results from this action. If this parameter is specified,
     * the response includes only records beyond the marker, up to the value
     * specified by MaxRecords.
     * 
     * 
     * @return An optional marker returned from a prior request. Use this marker
     *         for pagination of results from this action. 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 marker returned from a prior request. Use this marker for
     * pagination of results from this action. If this parameter is specified,
     * the response includes only records beyond the marker, up to the value
     * specified by MaxRecords.
     * 
     * 
     * @param marker
     *        An optional marker returned from a prior request. Use this marker
     *        for pagination of results from this action. 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 DescribeCacheParametersRequest 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 (getCacheParameterGroupName() != null)
            sb.append("CacheParameterGroupName: "
                    + getCacheParameterGroupName() + ",");
        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 boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof DescribeCacheParametersRequest == false)
            return false;
        DescribeCacheParametersRequest other = (DescribeCacheParametersRequest) obj;
        if (other.getCacheParameterGroupName() == null
                ^ this.getCacheParameterGroupName() == null)
            return false;
        if (other.getCacheParameterGroupName() != null
                && other.getCacheParameterGroupName().equals(
                        this.getCacheParameterGroupName()) == 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;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getCacheParameterGroupName() == null) ? 0
                        : getCacheParameterGroupName().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 DescribeCacheParametersRequest clone() {
        return (DescribeCacheParametersRequest) super.clone();
    }
}