com.amazonaws.services.ec2.model.PriceSchedule Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes the price for a Reserved Instance.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PriceSchedule implements Serializable, Cloneable {
/**
*
* The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
*
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for
* example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules
* for five months and two months, this means that schedule 1, covering the first three months of the remaining
* term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will
* be active for months 2 and 1.
*
*/
private Boolean active;
/**
*
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
*
*/
private String currencyCode;
/**
*
* The fixed price for the term.
*
*/
private Double price;
/**
*
* The number of months remaining in the reservation. For example, 2 is the second to the last month before the
* capacity reservation expires.
*
*/
private Long term;
/**
*
* The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
*
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for
* example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules
* for five months and two months, this means that schedule 1, covering the first three months of the remaining
* term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will
* be active for months 2 and 1.
*
*
* @param active
* The current price schedule, as determined by the term remaining for the Reserved Instance in the
* listing.
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time.
* Take, for example, a Reserved Instance listing that has five months remaining in its term. When you
* specify price schedules for five months and two months, this means that schedule 1, covering the first
* three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering
* the last two months of the term, will be active for months 2 and 1.
*/
public void setActive(Boolean active) {
this.active = active;
}
/**
*
* The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
*
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for
* example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules
* for five months and two months, this means that schedule 1, covering the first three months of the remaining
* term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will
* be active for months 2 and 1.
*
*
* @return The current price schedule, as determined by the term remaining for the Reserved Instance in the
* listing.
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time.
* Take, for example, a Reserved Instance listing that has five months remaining in its term. When you
* specify price schedules for five months and two months, this means that schedule 1, covering the first
* three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering
* the last two months of the term, will be active for months 2 and 1.
*/
public Boolean getActive() {
return this.active;
}
/**
*
* The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
*
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for
* example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules
* for five months and two months, this means that schedule 1, covering the first three months of the remaining
* term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will
* be active for months 2 and 1.
*
*
* @param active
* The current price schedule, as determined by the term remaining for the Reserved Instance in the
* listing.
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time.
* Take, for example, a Reserved Instance listing that has five months remaining in its term. When you
* specify price schedules for five months and two months, this means that schedule 1, covering the first
* three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering
* the last two months of the term, will be active for months 2 and 1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PriceSchedule withActive(Boolean active) {
setActive(active);
return this;
}
/**
*
* The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
*
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for
* example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules
* for five months and two months, this means that schedule 1, covering the first three months of the remaining
* term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will
* be active for months 2 and 1.
*
*
* @return The current price schedule, as determined by the term remaining for the Reserved Instance in the
* listing.
*
* A specific price schedule is always in effect, but only one price schedule can be active at any time.
* Take, for example, a Reserved Instance listing that has five months remaining in its term. When you
* specify price schedules for five months and two months, this means that schedule 1, covering the first
* three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering
* the last two months of the term, will be active for months 2 and 1.
*/
public Boolean isActive() {
return this.active;
}
/**
*
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
* @see CurrencyCodeValues
*/
public void setCurrencyCode(String currencyCode) {
this.currencyCode = currencyCode;
}
/**
*
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
*
*
* @return The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
* @see CurrencyCodeValues
*/
public String getCurrencyCode() {
return this.currencyCode;
}
/**
*
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CurrencyCodeValues
*/
public PriceSchedule withCurrencyCode(String currencyCode) {
setCurrencyCode(currencyCode);
return this;
}
/**
*
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
* @see CurrencyCodeValues
*/
public void setCurrencyCode(CurrencyCodeValues currencyCode) {
withCurrencyCode(currencyCode);
}
/**
*
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
* USD.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CurrencyCodeValues
*/
public PriceSchedule withCurrencyCode(CurrencyCodeValues currencyCode) {
this.currencyCode = currencyCode.toString();
return this;
}
/**
*
* The fixed price for the term.
*
*
* @param price
* The fixed price for the term.
*/
public void setPrice(Double price) {
this.price = price;
}
/**
*
* The fixed price for the term.
*
*
* @return The fixed price for the term.
*/
public Double getPrice() {
return this.price;
}
/**
*
* The fixed price for the term.
*
*
* @param price
* The fixed price for the term.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PriceSchedule withPrice(Double price) {
setPrice(price);
return this;
}
/**
*
* The number of months remaining in the reservation. For example, 2 is the second to the last month before the
* capacity reservation expires.
*
*
* @param term
* The number of months remaining in the reservation. For example, 2 is the second to the last month before
* the capacity reservation expires.
*/
public void setTerm(Long term) {
this.term = term;
}
/**
*
* The number of months remaining in the reservation. For example, 2 is the second to the last month before the
* capacity reservation expires.
*
*
* @return The number of months remaining in the reservation. For example, 2 is the second to the last month before
* the capacity reservation expires.
*/
public Long getTerm() {
return this.term;
}
/**
*
* The number of months remaining in the reservation. For example, 2 is the second to the last month before the
* capacity reservation expires.
*
*
* @param term
* The number of months remaining in the reservation. For example, 2 is the second to the last month before
* the capacity reservation expires.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PriceSchedule withTerm(Long term) {
setTerm(term);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getActive() != null)
sb.append("Active: ").append(getActive()).append(",");
if (getCurrencyCode() != null)
sb.append("CurrencyCode: ").append(getCurrencyCode()).append(",");
if (getPrice() != null)
sb.append("Price: ").append(getPrice()).append(",");
if (getTerm() != null)
sb.append("Term: ").append(getTerm());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PriceSchedule == false)
return false;
PriceSchedule other = (PriceSchedule) obj;
if (other.getActive() == null ^ this.getActive() == null)
return false;
if (other.getActive() != null && other.getActive().equals(this.getActive()) == 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.getPrice() == null ^ this.getPrice() == null)
return false;
if (other.getPrice() != null && other.getPrice().equals(this.getPrice()) == false)
return false;
if (other.getTerm() == null ^ this.getTerm() == null)
return false;
if (other.getTerm() != null && other.getTerm().equals(this.getTerm()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getActive() == null) ? 0 : getActive().hashCode());
hashCode = prime * hashCode + ((getCurrencyCode() == null) ? 0 : getCurrencyCode().hashCode());
hashCode = prime * hashCode + ((getPrice() == null) ? 0 : getPrice().hashCode());
hashCode = prime * hashCode + ((getTerm() == null) ? 0 : getTerm().hashCode());
return hashCode;
}
@Override
public PriceSchedule clone() {
try {
return (PriceSchedule) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}