com.amazonaws.services.rds.model.ReservedDBInstance Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds 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;
/**
 * 
 * This data type is used as a response element in the
 * DescribeReservedDBInstances and
 * PurchaseReservedDBInstancesOffering actions.
 * 
 */
public class ReservedDBInstance implements Serializable, Cloneable {
    /**
     * 
     * The unique identifier for the reservation.
     * 
     */
    private String reservedDBInstanceId;
    /**
     * 
     * The offering identifier.
     * 
     */
    private String reservedDBInstancesOfferingId;
    /**
     * 
     * The DB instance class for the reserved DB instance.
     * 
     */
    private String dBInstanceClass;
    /**
     * 
     * The time the reservation started.
     * 
     */
    private java.util.Date startTime;
    /**
     * 
     * The duration of the reservation in seconds.
     * 
     */
    private Integer duration;
    /**
     * 
     * The fixed price charged for this reserved DB instance.
     * 
     */
    private Double fixedPrice;
    /**
     * 
     * The hourly price charged for this reserved DB instance.
     * 
     */
    private Double usagePrice;
    /**
     * 
     * The currency code for the reserved DB instance.
     * 
     */
    private String currencyCode;
    /**
     * 
     * The number of reserved DB instances.
     * 
     */
    private Integer dBInstanceCount;
    /**
     * 
     * The description of the reserved DB instance.
     * 
     */
    private String productDescription;
    /**
     * 
     * The offering type of this reserved DB instance.
     * 
     */
    private String offeringType;
    /**
     * 
     * Indicates if the reservation applies to Multi-AZ deployments.
     * 
     */
    private Boolean multiAZ;
    /**
     * 
     * The state of the reserved DB instance.
     * 
     */
    private String state;
    /**
     * 
     * The recurring price charged to run this reserved DB instance.
     * 
     */
    private com.amazonaws.internal.SdkInternalList recurringCharges;
    /**
     * 
     * The unique identifier for the reservation.
     * 
     * 
     * @param reservedDBInstanceId
     *        The unique identifier for the reservation.
     */
    public void setReservedDBInstanceId(String reservedDBInstanceId) {
        this.reservedDBInstanceId = reservedDBInstanceId;
    }
    /**
     * 
     * The unique identifier for the reservation.
     * 
     * 
     * @return The unique identifier for the reservation.
     */
    public String getReservedDBInstanceId() {
        return this.reservedDBInstanceId;
    }
    /**
     * 
     * The unique identifier for the reservation.
     * 
     * 
     * @param reservedDBInstanceId
     *        The unique identifier for the reservation.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withReservedDBInstanceId(
            String reservedDBInstanceId) {
        setReservedDBInstanceId(reservedDBInstanceId);
        return this;
    }
    /**
     * 
     * The offering identifier.
     * 
     * 
     * @param reservedDBInstancesOfferingId
     *        The offering identifier.
     */
    public void setReservedDBInstancesOfferingId(
            String reservedDBInstancesOfferingId) {
        this.reservedDBInstancesOfferingId = reservedDBInstancesOfferingId;
    }
    /**
     * 
     * The offering identifier.
     * 
     * 
     * @return The offering identifier.
     */
    public String getReservedDBInstancesOfferingId() {
        return this.reservedDBInstancesOfferingId;
    }
    /**
     * 
     * The offering identifier.
     * 
     * 
     * @param reservedDBInstancesOfferingId
     *        The offering identifier.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withReservedDBInstancesOfferingId(
            String reservedDBInstancesOfferingId) {
        setReservedDBInstancesOfferingId(reservedDBInstancesOfferingId);
        return this;
    }
    /**
     * 
     * The DB instance class for the reserved DB instance.
     * 
     * 
     * @param dBInstanceClass
     *        The DB instance class for the reserved DB instance.
     */
    public void setDBInstanceClass(String dBInstanceClass) {
        this.dBInstanceClass = dBInstanceClass;
    }
    /**
     * 
     * The DB instance class for the reserved DB instance.
     * 
     * 
     * @return The DB instance class for the reserved DB instance.
     */
    public String getDBInstanceClass() {
        return this.dBInstanceClass;
    }
    /**
     * 
     * The DB instance class for the reserved DB instance.
     * 
     * 
     * @param dBInstanceClass
     *        The DB instance class for the reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withDBInstanceClass(String dBInstanceClass) {
        setDBInstanceClass(dBInstanceClass);
        return this;
    }
    /**
     * 
     * The time the reservation started.
     * 
     * 
     * @param startTime
     *        The time the reservation started.
     */
    public void setStartTime(java.util.Date startTime) {
        this.startTime = startTime;
    }
    /**
     * 
     * The time the reservation started.
     * 
     * 
     * @return The time the reservation started.
     */
    public java.util.Date getStartTime() {
        return this.startTime;
    }
    /**
     * 
     * The time the reservation started.
     * 
     * 
     * @param startTime
     *        The time the reservation started.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withStartTime(java.util.Date startTime) {
        setStartTime(startTime);
        return this;
    }
    /**
     * 
     * The duration of the reservation in seconds.
     * 
     * 
     * @param duration
     *        The duration of the reservation in seconds.
     */
    public void setDuration(Integer duration) {
        this.duration = duration;
    }
    /**
     * 
     * The duration of the reservation in seconds.
     * 
     * 
     * @return The duration of the reservation in seconds.
     */
    public Integer getDuration() {
        return this.duration;
    }
    /**
     * 
     * The duration of the reservation in seconds.
     * 
     * 
     * @param duration
     *        The duration of the reservation in seconds.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withDuration(Integer duration) {
        setDuration(duration);
        return this;
    }
    /**
     * 
     * The fixed price charged for this reserved DB instance.
     * 
     * 
     * @param fixedPrice
     *        The fixed price charged for this reserved DB instance.
     */
    public void setFixedPrice(Double fixedPrice) {
        this.fixedPrice = fixedPrice;
    }
    /**
     * 
     * The fixed price charged for this reserved DB instance.
     * 
     * 
     * @return The fixed price charged for this reserved DB instance.
     */
    public Double getFixedPrice() {
        return this.fixedPrice;
    }
    /**
     * 
     * The fixed price charged for this reserved DB instance.
     * 
     * 
     * @param fixedPrice
     *        The fixed price charged for this reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withFixedPrice(Double fixedPrice) {
        setFixedPrice(fixedPrice);
        return this;
    }
    /**
     * 
     * The hourly price charged for this reserved DB instance.
     * 
     * 
     * @param usagePrice
     *        The hourly price charged for this reserved DB instance.
     */
    public void setUsagePrice(Double usagePrice) {
        this.usagePrice = usagePrice;
    }
    /**
     * 
     * The hourly price charged for this reserved DB instance.
     * 
     * 
     * @return The hourly price charged for this reserved DB instance.
     */
    public Double getUsagePrice() {
        return this.usagePrice;
    }
    /**
     * 
     * The hourly price charged for this reserved DB instance.
     * 
     * 
     * @param usagePrice
     *        The hourly price charged for this reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withUsagePrice(Double usagePrice) {
        setUsagePrice(usagePrice);
        return this;
    }
    /**
     * 
     * The currency code for the reserved DB instance.
     * 
     * 
     * @param currencyCode
     *        The currency code for the reserved DB instance.
     */
    public void setCurrencyCode(String currencyCode) {
        this.currencyCode = currencyCode;
    }
    /**
     * 
     * The currency code for the reserved DB instance.
     * 
     * 
     * @return The currency code for the reserved DB instance.
     */
    public String getCurrencyCode() {
        return this.currencyCode;
    }
    /**
     * 
     * The currency code for the reserved DB instance.
     * 
     * 
     * @param currencyCode
     *        The currency code for the reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withCurrencyCode(String currencyCode) {
        setCurrencyCode(currencyCode);
        return this;
    }
    /**
     * 
     * The number of reserved DB instances.
     * 
     * 
     * @param dBInstanceCount
     *        The number of reserved DB instances.
     */
    public void setDBInstanceCount(Integer dBInstanceCount) {
        this.dBInstanceCount = dBInstanceCount;
    }
    /**
     * 
     * The number of reserved DB instances.
     * 
     * 
     * @return The number of reserved DB instances.
     */
    public Integer getDBInstanceCount() {
        return this.dBInstanceCount;
    }
    /**
     * 
     * The number of reserved DB instances.
     * 
     * 
     * @param dBInstanceCount
     *        The number of reserved DB instances.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withDBInstanceCount(Integer dBInstanceCount) {
        setDBInstanceCount(dBInstanceCount);
        return this;
    }
    /**
     * 
     * The description of the reserved DB instance.
     * 
     * 
     * @param productDescription
     *        The description of the reserved DB instance.
     */
    public void setProductDescription(String productDescription) {
        this.productDescription = productDescription;
    }
    /**
     * 
     * The description of the reserved DB instance.
     * 
     * 
     * @return The description of the reserved DB instance.
     */
    public String getProductDescription() {
        return this.productDescription;
    }
    /**
     * 
     * The description of the reserved DB instance.
     * 
     * 
     * @param productDescription
     *        The description of the reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withProductDescription(String productDescription) {
        setProductDescription(productDescription);
        return this;
    }
    /**
     * 
     * The offering type of this reserved DB instance.
     * 
     * 
     * @param offeringType
     *        The offering type of this reserved DB instance.
     */
    public void setOfferingType(String offeringType) {
        this.offeringType = offeringType;
    }
    /**
     * 
     * The offering type of this reserved DB instance.
     * 
     * 
     * @return The offering type of this reserved DB instance.
     */
    public String getOfferingType() {
        return this.offeringType;
    }
    /**
     * 
     * The offering type of this reserved DB instance.
     * 
     * 
     * @param offeringType
     *        The offering type of this reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withOfferingType(String offeringType) {
        setOfferingType(offeringType);
        return this;
    }
    /**
     * 
     * Indicates if the reservation applies to Multi-AZ deployments.
     * 
     * 
     * @param multiAZ
     *        Indicates if the reservation applies to Multi-AZ deployments.
     */
    public void setMultiAZ(Boolean multiAZ) {
        this.multiAZ = multiAZ;
    }
    /**
     * 
     * Indicates if the reservation applies to Multi-AZ deployments.
     * 
     * 
     * @return Indicates if the reservation applies to Multi-AZ deployments.
     */
    public Boolean getMultiAZ() {
        return this.multiAZ;
    }
    /**
     * 
     * Indicates if the reservation applies to Multi-AZ deployments.
     * 
     * 
     * @param multiAZ
     *        Indicates if the reservation applies to Multi-AZ deployments.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withMultiAZ(Boolean multiAZ) {
        setMultiAZ(multiAZ);
        return this;
    }
    /**
     * 
     * Indicates if the reservation applies to Multi-AZ deployments.
     * 
     * 
     * @return Indicates if the reservation applies to Multi-AZ deployments.
     */
    public Boolean isMultiAZ() {
        return this.multiAZ;
    }
    /**
     * 
     * The state of the reserved DB instance.
     * 
     * 
     * @param state
     *        The state of the reserved DB instance.
     */
    public void setState(String state) {
        this.state = state;
    }
    /**
     * 
     * The state of the reserved DB instance.
     * 
     * 
     * @return The state of the reserved DB instance.
     */
    public String getState() {
        return this.state;
    }
    /**
     * 
     * The state of the reserved DB instance.
     * 
     * 
     * @param state
     *        The state of the reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withState(String state) {
        setState(state);
        return this;
    }
    /**
     * 
     * The recurring price charged to run this reserved DB instance.
     * 
     * 
     * @return The recurring price charged to run this reserved DB instance.
     */
    public java.util.List getRecurringCharges() {
        if (recurringCharges == null) {
            recurringCharges = new com.amazonaws.internal.SdkInternalList();
        }
        return recurringCharges;
    }
    /**
     * 
     * The recurring price charged to run this reserved DB instance.
     * 
     * 
     * @param recurringCharges
     *        The recurring price charged to run this reserved DB instance.
     */
    public void setRecurringCharges(
            java.util.Collection recurringCharges) {
        if (recurringCharges == null) {
            this.recurringCharges = null;
            return;
        }
        this.recurringCharges = new com.amazonaws.internal.SdkInternalList(
                recurringCharges);
    }
    /**
     * 
     * The recurring price charged to run this reserved DB instance.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setRecurringCharges(java.util.Collection)} or
     * {@link #withRecurringCharges(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param recurringCharges
     *        The recurring price charged to run this reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withRecurringCharges(
            RecurringCharge... recurringCharges) {
        if (this.recurringCharges == null) {
            setRecurringCharges(new com.amazonaws.internal.SdkInternalList(
                    recurringCharges.length));
        }
        for (RecurringCharge ele : recurringCharges) {
            this.recurringCharges.add(ele);
        }
        return this;
    }
    /**
     * 
     * The recurring price charged to run this reserved DB instance.
     * 
     * 
     * @param recurringCharges
     *        The recurring price charged to run this reserved DB instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReservedDBInstance withRecurringCharges(
            java.util.Collection recurringCharges) {
        setRecurringCharges(recurringCharges);
        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 (getReservedDBInstanceId() != null)
            sb.append("ReservedDBInstanceId: " + getReservedDBInstanceId()
                    + ",");
        if (getReservedDBInstancesOfferingId() != null)
            sb.append("ReservedDBInstancesOfferingId: "
                    + getReservedDBInstancesOfferingId() + ",");
        if (getDBInstanceClass() != null)
            sb.append("DBInstanceClass: " + getDBInstanceClass() + ",");
        if (getStartTime() != null)
            sb.append("StartTime: " + getStartTime() + ",");
        if (getDuration() != null)
            sb.append("Duration: " + getDuration() + ",");
        if (getFixedPrice() != null)
            sb.append("FixedPrice: " + getFixedPrice() + ",");
        if (getUsagePrice() != null)
            sb.append("UsagePrice: " + getUsagePrice() + ",");
        if (getCurrencyCode() != null)
            sb.append("CurrencyCode: " + getCurrencyCode() + ",");
        if (getDBInstanceCount() != null)
            sb.append("DBInstanceCount: " + getDBInstanceCount() + ",");
        if (getProductDescription() != null)
            sb.append("ProductDescription: " + getProductDescription() + ",");
        if (getOfferingType() != null)
            sb.append("OfferingType: " + getOfferingType() + ",");
        if (getMultiAZ() != null)
            sb.append("MultiAZ: " + getMultiAZ() + ",");
        if (getState() != null)
            sb.append("State: " + getState() + ",");
        if (getRecurringCharges() != null)
            sb.append("RecurringCharges: " + getRecurringCharges());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof ReservedDBInstance == false)
            return false;
        ReservedDBInstance other = (ReservedDBInstance) obj;
        if (other.getReservedDBInstanceId() == null
                ^ this.getReservedDBInstanceId() == null)
            return false;
        if (other.getReservedDBInstanceId() != null
                && other.getReservedDBInstanceId().equals(
                        this.getReservedDBInstanceId()) == false)
            return false;
        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.getStartTime() == null ^ this.getStartTime() == null)
            return false;
        if (other.getStartTime() != null
                && other.getStartTime().equals(this.getStartTime()) == 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.getFixedPrice() == null ^ this.getFixedPrice() == null)
            return false;
        if (other.getFixedPrice() != null
                && other.getFixedPrice().equals(this.getFixedPrice()) == false)
            return false;
        if (other.getUsagePrice() == null ^ this.getUsagePrice() == null)
            return false;
        if (other.getUsagePrice() != null
                && other.getUsagePrice().equals(this.getUsagePrice()) == false)
            return false;
        if (other.getCurrencyCode() == null ^ this.getCurrencyCode() == null)
            return false;
        if (other.getCurrencyCode() != null
                && other.getCurrencyCode().equals(this.getCurrencyCode()) == false)
            return false;
        if (other.getDBInstanceCount() == null
                ^ this.getDBInstanceCount() == null)
            return false;
        if (other.getDBInstanceCount() != null
                && other.getDBInstanceCount().equals(this.getDBInstanceCount()) == 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.getState() == null ^ this.getState() == null)
            return false;
        if (other.getState() != null
                && other.getState().equals(this.getState()) == false)
            return false;
        if (other.getRecurringCharges() == null
                ^ this.getRecurringCharges() == null)
            return false;
        if (other.getRecurringCharges() != null
                && other.getRecurringCharges().equals(
                        this.getRecurringCharges()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getReservedDBInstanceId() == null) ? 0
                        : getReservedDBInstanceId().hashCode());
        hashCode = prime
                * hashCode
                + ((getReservedDBInstancesOfferingId() == null) ? 0
                        : getReservedDBInstancesOfferingId().hashCode());
        hashCode = prime
                * hashCode
                + ((getDBInstanceClass() == null) ? 0 : getDBInstanceClass()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
        hashCode = prime * hashCode
                + ((getDuration() == null) ? 0 : getDuration().hashCode());
        hashCode = prime * hashCode
                + ((getFixedPrice() == null) ? 0 : getFixedPrice().hashCode());
        hashCode = prime * hashCode
                + ((getUsagePrice() == null) ? 0 : getUsagePrice().hashCode());
        hashCode = prime
                * hashCode
                + ((getCurrencyCode() == null) ? 0 : getCurrencyCode()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getDBInstanceCount() == null) ? 0 : getDBInstanceCount()
                        .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
                + ((getState() == null) ? 0 : getState().hashCode());
        hashCode = prime
                * hashCode
                + ((getRecurringCharges() == null) ? 0 : getRecurringCharges()
                        .hashCode());
        return hashCode;
    }
    @Override
    public ReservedDBInstance clone() {
        try {
            return (ReservedDBInstance) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}