com.amazonaws.services.rds.model.DescribeReservedDBInstancesOfferingsRequest 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.rds.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 */
public class DescribeReservedDBInstancesOfferingsRequest extends
        AmazonWebServiceRequest implements Serializable, Cloneable {
    /**
     * 
     * The offering identifier filter value. Specify this parameter to show only
     * the available offering that matches the specified reservation identifier.
     * 
     * 
     * Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
     * 
     */
    private String reservedDBInstancesOfferingId;
    /**
     * 
     * The DB instance class filter value. Specify this parameter to show only
     * the available offerings matching the specified DB instance class.
     * 
     */
    private String dBInstanceClass;
    /**
     * 
     * Duration filter value, specified in years or seconds. Specify this
     * parameter to show only reservations for this duration.
     * 
     * 
     * Valid Values: 1 | 3 | 31536000 | 94608000
     * 
     */
    private String duration;
    /**
     * 
     * Product description filter value. Specify this parameter to show only the
     * available offerings matching the specified product description.
     * 
     */
    private String productDescription;
    /**
     * 
     * The offering type filter value. Specify this parameter to show only the
     * available offerings matching the specified offering type.
     * 
     * 
     * Valid Values:
     * "Partial Upfront" | "All Upfront" | "No Upfront" 
     * 
     */
    private String offeringType;
    /**
     * 
     * The Multi-AZ filter value. Specify this parameter to show only the
     * available offerings matching the specified Multi-AZ parameter.
     * 
     */
    private Boolean multiAZ;
    /**
     * 
     * This parameter is not currently supported.
     * 
     */
    private com.amazonaws.internal.SdkInternalList filters;
    /**
     * 
     * The maximum number of records to include in the response. If more than
     * the MaxRecords value is available, a pagination token called
     * a marker is included in the response so that the following results can be
     * retrieved.
     * 
     * 
     * Default: 100
     * 
     * 
     * Constraints: Minimum 20, maximum 100.
     * 
     */
    private Integer maxRecords;
    /**
     * 
     * An optional pagination token provided by a previous 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 offering identifier filter value. Specify this parameter to show only
     * the available offering that matches the specified reservation identifier.
     * 
     * 
     * Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
     * 
     * 
     * @param reservedDBInstancesOfferingId
     *        The offering identifier filter value. Specify this parameter to
     *        show only the available offering that matches the specified
     *        reservation identifier.
     *        
     *        Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
     */
    public void setReservedDBInstancesOfferingId(
            String reservedDBInstancesOfferingId) {
        this.reservedDBInstancesOfferingId = reservedDBInstancesOfferingId;
    }
    /**
     * 
     * The offering identifier filter value. Specify this parameter to show only
     * the available offering that matches the specified reservation identifier.
     * 
     * 
     * Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
     * 
     * 
     * @return The offering identifier filter value. Specify this parameter to
     *         show only the available offering that matches the specified
     *         reservation identifier.
     *         
     *         Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
     */
    public String getReservedDBInstancesOfferingId() {
        return this.reservedDBInstancesOfferingId;
    }
    /**
     * 
     * The offering identifier filter value. Specify this parameter to show only
     * the available offering that matches the specified reservation identifier.
     * 
     * 
     * Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
     * 
     * 
     * @param reservedDBInstancesOfferingId
     *        The offering identifier filter value. Specify this parameter to
     *        show only the available offering that matches the specified
     *        reservation identifier.
     *        
     *        Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeReservedDBInstancesOfferingsRequest withReservedDBInstancesOfferingId(
            String reservedDBInstancesOfferingId) {
        setReservedDBInstancesOfferingId(reservedDBInstancesOfferingId);
        return this;
    }
    /**
     * 
     * The DB instance class filter value. Specify this parameter to show only
     * the available offerings matching the specified DB instance class.
     * 
     * 
     * @param dBInstanceClass
     *        The DB instance class filter value. Specify this parameter to show
     *        only the available offerings matching the specified DB instance
     *        class.
     */
    public void setDBInstanceClass(String dBInstanceClass) {
        this.dBInstanceClass = dBInstanceClass;
    }
    /**
     * 
     * The DB instance class filter value. Specify this parameter to show only
     * the available offerings matching the specified DB instance class.
     * 
     * 
     * @return The DB instance class filter value. Specify this parameter to
     *         show only the available offerings matching the specified DB
     *         instance class.
     */
    public String getDBInstanceClass() {
        return this.dBInstanceClass;
    }
    /**
     * 
     * The DB instance class filter value. Specify this parameter to show only
     * the available offerings matching the specified DB instance class.
     * 
     * 
     * @param dBInstanceClass
     *        The DB instance class filter value. Specify this parameter to show
     *        only the available offerings matching the specified DB instance
     *        class.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeReservedDBInstancesOfferingsRequest withDBInstanceClass(
            String dBInstanceClass) {
        setDBInstanceClass(dBInstanceClass);
        return this;
    }
    /**
     * 
     * Duration filter value, specified in years or seconds. Specify this
     * parameter to show only reservations for this duration.
     * 
     * 
     * Valid Values: 1 | 3 | 31536000 | 94608000
     * 
     * 
     * @param duration
     *        Duration filter value, specified in years or seconds. Specify this
     *        parameter to show only reservations for this duration.
     *        
     *        Valid Values: 1 | 3 | 31536000 | 94608000
     */
    public void setDuration(String duration) {
        this.duration = duration;
    }
    /**
     * 
     * Duration filter value, specified in years or seconds. Specify this
     * parameter to show only reservations for this duration.
     * 
     * 
     * Valid Values: 1 | 3 | 31536000 | 94608000
     * 
     * 
     * @return Duration filter value, specified in years or seconds. Specify
     *         this parameter to show only reservations for this duration.
     *         
     *         Valid Values: 1 | 3 | 31536000 | 94608000
     */
    public String getDuration() {
        return this.duration;
    }
    /**
     * 
     * Duration filter value, specified in years or seconds. Specify this
     * parameter to show only reservations for this duration.
     * 
     * 
     * Valid Values: 1 | 3 | 31536000 | 94608000
     * 
     * 
     * @param duration
     *        Duration filter value, specified in years or seconds. Specify this
     *        parameter to show only reservations for this duration.
     *        
     *        Valid Values: 1 | 3 | 31536000 | 94608000
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeReservedDBInstancesOfferingsRequest withDuration(
            String duration) {
        setDuration(duration);
        return this;
    }
    /**
     * 
     * Product description filter value. Specify this parameter to show only the
     * available offerings matching the specified product description.
     * 
     * 
     * @param productDescription
     *        Product description filter value. Specify this parameter to show
     *        only the available offerings matching the specified product
     *        description.
     */
    public void setProductDescription(String productDescription) {
        this.productDescription = productDescription;
    }
    /**
     * 
     * Product description filter value. Specify this parameter to show only the
     * available offerings matching the specified product description.
     * 
     * 
     * @return Product description filter value. Specify this parameter to show
     *         only the available offerings matching the specified product
     *         description.
     */
    public String getProductDescription() {
        return this.productDescription;
    }
    /**
     * 
     * Product description filter value. Specify this parameter to show only the
     * available offerings matching the specified product description.
     * 
     * 
     * @param productDescription
     *        Product description filter value. Specify this parameter to show
     *        only the available offerings matching the specified product
     *        description.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeReservedDBInstancesOfferingsRequest withProductDescription(
            String productDescription) {
        setProductDescription(productDescription);
        return this;
    }
    /**
     * 
     * The offering type filter value. Specify this parameter to show only the
     * available offerings matching the specified offering type.
     * 
     * 
     * Valid Values:
     * "Partial Upfront" | "All Upfront" | "No Upfront" 
     * 
     * 
     * @param offeringType
     *        The offering type filter value. Specify this parameter to show
     *        only the available offerings matching the specified offering
     *        type.
     *        
     *        Valid Values:
     *        "Partial Upfront" | "All Upfront" | "No Upfront" 
     */
    public void setOfferingType(String offeringType) {
        this.offeringType = offeringType;
    }
    /**
     * 
     * The offering type filter value. Specify this parameter to show only the
     * available offerings matching the specified offering type.
     * 
     * 
     * Valid Values:
     * "Partial Upfront" | "All Upfront" | "No Upfront" 
     * 
     * 
     * @return The offering type filter value. Specify this parameter to show
     *         only the available offerings matching the specified offering
     *         type.
     *         
     *         Valid Values:
     *         "Partial Upfront" | "All Upfront" | "No Upfront" 
     */
    public String getOfferingType() {
        return this.offeringType;
    }
    /**
     * 
     * The offering type filter value. Specify this parameter to show only the
     * available offerings matching the specified offering type.
     * 
     * 
     * Valid Values:
     * "Partial Upfront" | "All Upfront" | "No Upfront" 
     * 
     * 
     * @param offeringType
     *        The offering type filter value. Specify this parameter to show
     *        only the available offerings matching the specified offering
     *        type.
     *        
     *        Valid Values:
     *        "Partial Upfront" | "All Upfront" | "No Upfront" 
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeReservedDBInstancesOfferingsRequest withOfferingType(
            String offeringType) {
        setOfferingType(offeringType);
        return this;
    }
    /**
     * 
     * The Multi-AZ filter value. Specify this parameter to show only the
     * available offerings matching the specified Multi-AZ parameter.
     * 
     * 
     * @param multiAZ
     *        The Multi-AZ filter value. Specify this parameter to show only the
     *        available offerings matching the specified Multi-AZ parameter.
     */
    public void setMultiAZ(Boolean multiAZ) {
        this.multiAZ = multiAZ;
    }
    /**
     * 
     * The Multi-AZ filter value. Specify this parameter to show only the
     * available offerings matching the specified Multi-AZ parameter.
     * 
     * 
     * @return The Multi-AZ filter value. Specify this parameter to show only
     *         the available offerings matching the specified Multi-AZ
     *         parameter.
     */
    public Boolean getMultiAZ() {
        return this.multiAZ;
    }
    /**
     * 
     * The Multi-AZ filter value. Specify this parameter to show only the
     * available offerings matching the specified Multi-AZ parameter.
     * 
     * 
     * @param multiAZ
     *        The Multi-AZ filter value. Specify this parameter to show only the
     *        available offerings matching the specified Multi-AZ parameter.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeReservedDBInstancesOfferingsRequest withMultiAZ(
            Boolean multiAZ) {
        setMultiAZ(multiAZ);
        return this;
    }
    /**
     * 
     * The Multi-AZ filter value. Specify this parameter to show only the
     * available offerings matching the specified Multi-AZ parameter.
     * 
     * 
     * @return The Multi-AZ filter value. Specify this parameter to show only
     *         the available offerings matching the specified Multi-AZ
     *         parameter.
     */
    public Boolean isMultiAZ() {
        return this.multiAZ;
    }
    /**
     * 
     * 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 DescribeReservedDBInstancesOfferingsRequest 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 DescribeReservedDBInstancesOfferingsRequest withFilters(
            java.util.Collection filters) {
        setFilters(filters);
        return this;
    }
    /**
     * 
     * The maximum number of records to include in the response. If more than
     * the MaxRecords value is available, a pagination token called
     * a marker is included in the response so that the following 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
     *        than the MaxRecords value is available, a pagination
     *        token called a marker is included in the response so that the
     *        following 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 than
     * the MaxRecords value is available, a pagination token called
     * a marker is included in the response so that the following results can be
     * retrieved.
     * 
     * 
     * Default: 100
     * 
     * 
     * Constraints: Minimum 20, maximum 100.
     * 
     * 
     * @return The maximum number of records to include in the response. If more
     *         than the MaxRecords value is available, a pagination
     *         token called a marker is included in the response so that the
     *         following 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 than
     * the MaxRecords value is available, a pagination token called
     * a marker is included in the response so that the following 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
     *        than the MaxRecords value is available, a pagination
     *        token called a marker is included in the response so that the
     *        following 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 DescribeReservedDBInstancesOfferingsRequest withMaxRecords(
            Integer maxRecords) {
        setMaxRecords(maxRecords);
        return this;
    }
    /**
     * 
     * An optional pagination token provided by a previous 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 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 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 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 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 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 DescribeReservedDBInstancesOfferingsRequest 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 (getReservedDBInstancesOfferingId() != null)
            sb.append("ReservedDBInstancesOfferingId: "
                    + getReservedDBInstancesOfferingId() + ",");
        if (getDBInstanceClass() != null)
            sb.append("DBInstanceClass: " + getDBInstanceClass() + ",");
        if (getDuration() != null)
            sb.append("Duration: " + getDuration() + ",");
        if (getProductDescription() != null)
            sb.append("ProductDescription: " + getProductDescription() + ",");
        if (getOfferingType() != null)
            sb.append("OfferingType: " + getOfferingType() + ",");
        if (getMultiAZ() != null)
            sb.append("MultiAZ: " + getMultiAZ() + ",");
        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 DescribeReservedDBInstancesOfferingsRequest == false)
            return false;
        DescribeReservedDBInstancesOfferingsRequest other = (DescribeReservedDBInstancesOfferingsRequest) obj;
        if (other.getReservedDBInstancesOfferingId() == null
                ^ this.getReservedDBInstancesOfferingId() == null)
            return false;
        if (other.getReservedDBInstancesOfferingId() != null
                && other.getReservedDBInstancesOfferingId().equals(
                        this.getReservedDBInstancesOfferingId()) == false)
            return false;
        if (other.getDBInstanceClass() == null
                ^ this.getDBInstanceClass() == null)
            return false;
        if (other.getDBInstanceClass() != null
                && other.getDBInstanceClass().equals(this.getDBInstanceClass()) == false)
            return false;
        if (other.getDuration() == null ^ this.getDuration() == null)
            return false;
        if (other.getDuration() != null
                && other.getDuration().equals(this.getDuration()) == false)
            return false;
        if (other.getProductDescription() == null
                ^ this.getProductDescription() == null)
            return false;
        if (other.getProductDescription() != null
                && other.getProductDescription().equals(
                        this.getProductDescription()) == false)
            return false;
        if (other.getOfferingType() == null ^ this.getOfferingType() == null)
            return false;
        if (other.getOfferingType() != null
                && other.getOfferingType().equals(this.getOfferingType()) == false)
            return false;
        if (other.getMultiAZ() == null ^ this.getMultiAZ() == null)
            return false;
        if (other.getMultiAZ() != null
                && other.getMultiAZ().equals(this.getMultiAZ()) == 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
                + ((getReservedDBInstancesOfferingId() == null) ? 0
                        : getReservedDBInstancesOfferingId().hashCode());
        hashCode = prime
                * hashCode
                + ((getDBInstanceClass() == null) ? 0 : getDBInstanceClass()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getDuration() == null) ? 0 : getDuration().hashCode());
        hashCode = prime
                * hashCode
                + ((getProductDescription() == null) ? 0
                        : getProductDescription().hashCode());
        hashCode = prime
                * hashCode
                + ((getOfferingType() == null) ? 0 : getOfferingType()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getMultiAZ() == null) ? 0 : getMultiAZ().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 DescribeReservedDBInstancesOfferingsRequest clone() {
        return (DescribeReservedDBInstancesOfferingsRequest) super.clone();
    }
}