com.amazonaws.services.ec2.model.HostReservation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* Details about the Dedicated Host Reservation and associated Dedicated Hosts.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class HostReservation implements Serializable, Cloneable {
/**
*
* The number of Dedicated Hosts the reservation is associated with.
*
*/
private Integer count;
/**
*
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this
* time, the only supported currency is USD.
*
*/
private String currencyCode;
/**
*
* The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
* 94608000 (3 years).
*
*/
private Integer duration;
/**
*
* The date and time that the reservation ends.
*
*/
private java.util.Date end;
/**
*
* The IDs of the Dedicated Hosts associated with the reservation.
*
*/
private com.amazonaws.internal.SdkInternalList hostIdSet;
/**
*
* The ID of the reservation that specifies the associated Dedicated Hosts.
*
*/
private String hostReservationId;
/**
*
* The hourly price of the reservation.
*
*/
private String hourlyPrice;
/**
*
* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same
* in order for it to benefit from the reservation.
*
*/
private String instanceFamily;
/**
*
* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
*
*/
private String offeringId;
/**
*
* The payment option selected for this reservation.
*
*/
private String paymentOption;
/**
*
* The date and time that the reservation started.
*
*/
private java.util.Date start;
/**
*
* The state of the reservation.
*
*/
private String state;
/**
*
* The upfront price of the reservation.
*
*/
private String upfrontPrice;
/**
*
* Any tags assigned to the Dedicated Host Reservation.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The number of Dedicated Hosts the reservation is associated with.
*
*
* @param count
* The number of Dedicated Hosts the reservation is associated with.
*/
public void setCount(Integer count) {
this.count = count;
}
/**
*
* The number of Dedicated Hosts the reservation is associated with.
*
*
* @return The number of Dedicated Hosts the reservation is associated with.
*/
public Integer getCount() {
return this.count;
}
/**
*
* The number of Dedicated Hosts the reservation is associated with.
*
*
* @param count
* The number of Dedicated Hosts the reservation is associated with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withCount(Integer count) {
setCount(count);
return this;
}
/**
*
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this
* time, the only supported currency is USD.
*
*
* @param currencyCode
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At
* this time, the only supported currency is USD.
* @see CurrencyCodeValues
*/
public void setCurrencyCode(String currencyCode) {
this.currencyCode = currencyCode;
}
/**
*
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this
* time, the only supported currency is USD.
*
*
* @return The currency in which the upfrontPrice and hourlyPrice amounts are specified.
* At this time, the only supported currency is USD.
* @see CurrencyCodeValues
*/
public String getCurrencyCode() {
return this.currencyCode;
}
/**
*
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this
* time, the only supported currency is USD.
*
*
* @param currencyCode
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. 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 HostReservation withCurrencyCode(String currencyCode) {
setCurrencyCode(currencyCode);
return this;
}
/**
*
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this
* time, the only supported currency is USD.
*
*
* @param currencyCode
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At
* this time, the only supported currency is USD.
* @see CurrencyCodeValues
*/
public void setCurrencyCode(CurrencyCodeValues currencyCode) {
withCurrencyCode(currencyCode);
}
/**
*
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this
* time, the only supported currency is USD.
*
*
* @param currencyCode
* The currency in which the upfrontPrice and hourlyPrice amounts are specified. 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 HostReservation withCurrencyCode(CurrencyCodeValues currencyCode) {
this.currencyCode = currencyCode.toString();
return this;
}
/**
*
* The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
* 94608000 (3 years).
*
*
* @param duration
* The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
* 94608000 (3 years).
*/
public void setDuration(Integer duration) {
this.duration = duration;
}
/**
*
* The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
* 94608000 (3 years).
*
*
* @return The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
* 94608000 (3 years).
*/
public Integer getDuration() {
return this.duration;
}
/**
*
* The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
* 94608000 (3 years).
*
*
* @param duration
* The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
* 94608000 (3 years).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withDuration(Integer duration) {
setDuration(duration);
return this;
}
/**
*
* The date and time that the reservation ends.
*
*
* @param end
* The date and time that the reservation ends.
*/
public void setEnd(java.util.Date end) {
this.end = end;
}
/**
*
* The date and time that the reservation ends.
*
*
* @return The date and time that the reservation ends.
*/
public java.util.Date getEnd() {
return this.end;
}
/**
*
* The date and time that the reservation ends.
*
*
* @param end
* The date and time that the reservation ends.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withEnd(java.util.Date end) {
setEnd(end);
return this;
}
/**
*
* The IDs of the Dedicated Hosts associated with the reservation.
*
*
* @return The IDs of the Dedicated Hosts associated with the reservation.
*/
public java.util.List getHostIdSet() {
if (hostIdSet == null) {
hostIdSet = new com.amazonaws.internal.SdkInternalList();
}
return hostIdSet;
}
/**
*
* The IDs of the Dedicated Hosts associated with the reservation.
*
*
* @param hostIdSet
* The IDs of the Dedicated Hosts associated with the reservation.
*/
public void setHostIdSet(java.util.Collection hostIdSet) {
if (hostIdSet == null) {
this.hostIdSet = null;
return;
}
this.hostIdSet = new com.amazonaws.internal.SdkInternalList(hostIdSet);
}
/**
*
* The IDs of the Dedicated Hosts associated with the reservation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setHostIdSet(java.util.Collection)} or {@link #withHostIdSet(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param hostIdSet
* The IDs of the Dedicated Hosts associated with the reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withHostIdSet(String... hostIdSet) {
if (this.hostIdSet == null) {
setHostIdSet(new com.amazonaws.internal.SdkInternalList(hostIdSet.length));
}
for (String ele : hostIdSet) {
this.hostIdSet.add(ele);
}
return this;
}
/**
*
* The IDs of the Dedicated Hosts associated with the reservation.
*
*
* @param hostIdSet
* The IDs of the Dedicated Hosts associated with the reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withHostIdSet(java.util.Collection hostIdSet) {
setHostIdSet(hostIdSet);
return this;
}
/**
*
* The ID of the reservation that specifies the associated Dedicated Hosts.
*
*
* @param hostReservationId
* The ID of the reservation that specifies the associated Dedicated Hosts.
*/
public void setHostReservationId(String hostReservationId) {
this.hostReservationId = hostReservationId;
}
/**
*
* The ID of the reservation that specifies the associated Dedicated Hosts.
*
*
* @return The ID of the reservation that specifies the associated Dedicated Hosts.
*/
public String getHostReservationId() {
return this.hostReservationId;
}
/**
*
* The ID of the reservation that specifies the associated Dedicated Hosts.
*
*
* @param hostReservationId
* The ID of the reservation that specifies the associated Dedicated Hosts.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withHostReservationId(String hostReservationId) {
setHostReservationId(hostReservationId);
return this;
}
/**
*
* The hourly price of the reservation.
*
*
* @param hourlyPrice
* The hourly price of the reservation.
*/
public void setHourlyPrice(String hourlyPrice) {
this.hourlyPrice = hourlyPrice;
}
/**
*
* The hourly price of the reservation.
*
*
* @return The hourly price of the reservation.
*/
public String getHourlyPrice() {
return this.hourlyPrice;
}
/**
*
* The hourly price of the reservation.
*
*
* @param hourlyPrice
* The hourly price of the reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withHourlyPrice(String hourlyPrice) {
setHourlyPrice(hourlyPrice);
return this;
}
/**
*
* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same
* in order for it to benefit from the reservation.
*
*
* @param instanceFamily
* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be
* the same in order for it to benefit from the reservation.
*/
public void setInstanceFamily(String instanceFamily) {
this.instanceFamily = instanceFamily;
}
/**
*
* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same
* in order for it to benefit from the reservation.
*
*
* @return The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be
* the same in order for it to benefit from the reservation.
*/
public String getInstanceFamily() {
return this.instanceFamily;
}
/**
*
* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same
* in order for it to benefit from the reservation.
*
*
* @param instanceFamily
* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be
* the same in order for it to benefit from the reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withInstanceFamily(String instanceFamily) {
setInstanceFamily(instanceFamily);
return this;
}
/**
*
* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
*
*
* @param offeringId
* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with
* it.
*/
public void setOfferingId(String offeringId) {
this.offeringId = offeringId;
}
/**
*
* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
*
*
* @return The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with
* it.
*/
public String getOfferingId() {
return this.offeringId;
}
/**
*
* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
*
*
* @param offeringId
* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with
* it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withOfferingId(String offeringId) {
setOfferingId(offeringId);
return this;
}
/**
*
* The payment option selected for this reservation.
*
*
* @param paymentOption
* The payment option selected for this reservation.
* @see PaymentOption
*/
public void setPaymentOption(String paymentOption) {
this.paymentOption = paymentOption;
}
/**
*
* The payment option selected for this reservation.
*
*
* @return The payment option selected for this reservation.
* @see PaymentOption
*/
public String getPaymentOption() {
return this.paymentOption;
}
/**
*
* The payment option selected for this reservation.
*
*
* @param paymentOption
* The payment option selected for this reservation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PaymentOption
*/
public HostReservation withPaymentOption(String paymentOption) {
setPaymentOption(paymentOption);
return this;
}
/**
*
* The payment option selected for this reservation.
*
*
* @param paymentOption
* The payment option selected for this reservation.
* @see PaymentOption
*/
public void setPaymentOption(PaymentOption paymentOption) {
withPaymentOption(paymentOption);
}
/**
*
* The payment option selected for this reservation.
*
*
* @param paymentOption
* The payment option selected for this reservation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PaymentOption
*/
public HostReservation withPaymentOption(PaymentOption paymentOption) {
this.paymentOption = paymentOption.toString();
return this;
}
/**
*
* The date and time that the reservation started.
*
*
* @param start
* The date and time that the reservation started.
*/
public void setStart(java.util.Date start) {
this.start = start;
}
/**
*
* The date and time that the reservation started.
*
*
* @return The date and time that the reservation started.
*/
public java.util.Date getStart() {
return this.start;
}
/**
*
* The date and time that the reservation started.
*
*
* @param start
* The date and time that the reservation started.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withStart(java.util.Date start) {
setStart(start);
return this;
}
/**
*
* The state of the reservation.
*
*
* @param state
* The state of the reservation.
* @see ReservationState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The state of the reservation.
*
*
* @return The state of the reservation.
* @see ReservationState
*/
public String getState() {
return this.state;
}
/**
*
* The state of the reservation.
*
*
* @param state
* The state of the reservation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReservationState
*/
public HostReservation withState(String state) {
setState(state);
return this;
}
/**
*
* The state of the reservation.
*
*
* @param state
* The state of the reservation.
* @see ReservationState
*/
public void setState(ReservationState state) {
withState(state);
}
/**
*
* The state of the reservation.
*
*
* @param state
* The state of the reservation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReservationState
*/
public HostReservation withState(ReservationState state) {
this.state = state.toString();
return this;
}
/**
*
* The upfront price of the reservation.
*
*
* @param upfrontPrice
* The upfront price of the reservation.
*/
public void setUpfrontPrice(String upfrontPrice) {
this.upfrontPrice = upfrontPrice;
}
/**
*
* The upfront price of the reservation.
*
*
* @return The upfront price of the reservation.
*/
public String getUpfrontPrice() {
return this.upfrontPrice;
}
/**
*
* The upfront price of the reservation.
*
*
* @param upfrontPrice
* The upfront price of the reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withUpfrontPrice(String upfrontPrice) {
setUpfrontPrice(upfrontPrice);
return this;
}
/**
*
* Any tags assigned to the Dedicated Host Reservation.
*
*
* @return Any tags assigned to the Dedicated Host Reservation.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Any tags assigned to the Dedicated Host Reservation.
*
*
* @param tags
* Any tags assigned to the Dedicated Host Reservation.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* Any tags assigned to the Dedicated Host Reservation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Any tags assigned to the Dedicated Host Reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Any tags assigned to the Dedicated Host Reservation.
*
*
* @param tags
* Any tags assigned to the Dedicated Host Reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HostReservation withTags(java.util.Collection tags) {
setTags(tags);
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 (getCount() != null)
sb.append("Count: ").append(getCount()).append(",");
if (getCurrencyCode() != null)
sb.append("CurrencyCode: ").append(getCurrencyCode()).append(",");
if (getDuration() != null)
sb.append("Duration: ").append(getDuration()).append(",");
if (getEnd() != null)
sb.append("End: ").append(getEnd()).append(",");
if (getHostIdSet() != null)
sb.append("HostIdSet: ").append(getHostIdSet()).append(",");
if (getHostReservationId() != null)
sb.append("HostReservationId: ").append(getHostReservationId()).append(",");
if (getHourlyPrice() != null)
sb.append("HourlyPrice: ").append(getHourlyPrice()).append(",");
if (getInstanceFamily() != null)
sb.append("InstanceFamily: ").append(getInstanceFamily()).append(",");
if (getOfferingId() != null)
sb.append("OfferingId: ").append(getOfferingId()).append(",");
if (getPaymentOption() != null)
sb.append("PaymentOption: ").append(getPaymentOption()).append(",");
if (getStart() != null)
sb.append("Start: ").append(getStart()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getUpfrontPrice() != null)
sb.append("UpfrontPrice: ").append(getUpfrontPrice()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof HostReservation == false)
return false;
HostReservation other = (HostReservation) obj;
if (other.getCount() == null ^ this.getCount() == null)
return false;
if (other.getCount() != null && other.getCount().equals(this.getCount()) == 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.getDuration() == null ^ this.getDuration() == null)
return false;
if (other.getDuration() != null && other.getDuration().equals(this.getDuration()) == false)
return false;
if (other.getEnd() == null ^ this.getEnd() == null)
return false;
if (other.getEnd() != null && other.getEnd().equals(this.getEnd()) == false)
return false;
if (other.getHostIdSet() == null ^ this.getHostIdSet() == null)
return false;
if (other.getHostIdSet() != null && other.getHostIdSet().equals(this.getHostIdSet()) == false)
return false;
if (other.getHostReservationId() == null ^ this.getHostReservationId() == null)
return false;
if (other.getHostReservationId() != null && other.getHostReservationId().equals(this.getHostReservationId()) == false)
return false;
if (other.getHourlyPrice() == null ^ this.getHourlyPrice() == null)
return false;
if (other.getHourlyPrice() != null && other.getHourlyPrice().equals(this.getHourlyPrice()) == false)
return false;
if (other.getInstanceFamily() == null ^ this.getInstanceFamily() == null)
return false;
if (other.getInstanceFamily() != null && other.getInstanceFamily().equals(this.getInstanceFamily()) == false)
return false;
if (other.getOfferingId() == null ^ this.getOfferingId() == null)
return false;
if (other.getOfferingId() != null && other.getOfferingId().equals(this.getOfferingId()) == false)
return false;
if (other.getPaymentOption() == null ^ this.getPaymentOption() == null)
return false;
if (other.getPaymentOption() != null && other.getPaymentOption().equals(this.getPaymentOption()) == false)
return false;
if (other.getStart() == null ^ this.getStart() == null)
return false;
if (other.getStart() != null && other.getStart().equals(this.getStart()) == 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.getUpfrontPrice() == null ^ this.getUpfrontPrice() == null)
return false;
if (other.getUpfrontPrice() != null && other.getUpfrontPrice().equals(this.getUpfrontPrice()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCount() == null) ? 0 : getCount().hashCode());
hashCode = prime * hashCode + ((getCurrencyCode() == null) ? 0 : getCurrencyCode().hashCode());
hashCode = prime * hashCode + ((getDuration() == null) ? 0 : getDuration().hashCode());
hashCode = prime * hashCode + ((getEnd() == null) ? 0 : getEnd().hashCode());
hashCode = prime * hashCode + ((getHostIdSet() == null) ? 0 : getHostIdSet().hashCode());
hashCode = prime * hashCode + ((getHostReservationId() == null) ? 0 : getHostReservationId().hashCode());
hashCode = prime * hashCode + ((getHourlyPrice() == null) ? 0 : getHourlyPrice().hashCode());
hashCode = prime * hashCode + ((getInstanceFamily() == null) ? 0 : getInstanceFamily().hashCode());
hashCode = prime * hashCode + ((getOfferingId() == null) ? 0 : getOfferingId().hashCode());
hashCode = prime * hashCode + ((getPaymentOption() == null) ? 0 : getPaymentOption().hashCode());
hashCode = prime * hashCode + ((getStart() == null) ? 0 : getStart().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getUpfrontPrice() == null) ? 0 : getUpfrontPrice().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public HostReservation clone() {
try {
return (HostReservation) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}