com.amazonaws.services.ec2.model.PurchaseHostReservationRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.PurchaseHostReservationRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PurchaseHostReservationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* Idempotency.
*
*/
private String clientToken;
/**
*
* The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice amounts are specified. At this time, the only supported currency is
* USD.
*
*/
private String currencyCode;
/**
*
* The IDs of the Dedicated Hosts with which the reservation will be associated.
*
*/
private com.amazonaws.internal.SdkInternalList hostIdSet;
/**
*
* The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's
* upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit,
* the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the
* purchase. At this time, the only supported currency is USD. For example, to indicate a limit price
* of USD 100, specify 100.00.
*
*/
private String limitPrice;
/**
*
* The ID of the offering.
*
*/
private String offeringId;
/**
*
* The tags to apply to the Dedicated Host Reservation during purchase.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* Idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* Idempotency.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* Idempotency.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* Idempotency.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* Idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* Idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PurchaseHostReservationRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice amounts are specified. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice 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 totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice amounts are specified. At this time, the only supported currency is
* USD.
*
*
* @return The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice 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 totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice amounts are specified. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice 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 PurchaseHostReservationRequest withCurrencyCode(String currencyCode) {
setCurrencyCode(currencyCode);
return this;
}
/**
*
* The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice amounts are specified. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice 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 totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice amounts are specified. At this time, the only supported currency is
* USD.
*
*
* @param currencyCode
* The currency in which the totalUpfrontPrice, LimitPrice, and
* totalHourlyPrice 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 PurchaseHostReservationRequest withCurrencyCode(CurrencyCodeValues currencyCode) {
this.currencyCode = currencyCode.toString();
return this;
}
/**
*
* The IDs of the Dedicated Hosts with which the reservation will be associated.
*
*
* @return The IDs of the Dedicated Hosts with which the reservation will be associated.
*/
public java.util.List getHostIdSet() {
if (hostIdSet == null) {
hostIdSet = new com.amazonaws.internal.SdkInternalList();
}
return hostIdSet;
}
/**
*
* The IDs of the Dedicated Hosts with which the reservation will be associated.
*
*
* @param hostIdSet
* The IDs of the Dedicated Hosts with which the reservation will be associated.
*/
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 with which the reservation will be associated.
*
*
* 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 with which the reservation will be associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PurchaseHostReservationRequest 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 with which the reservation will be associated.
*
*
* @param hostIdSet
* The IDs of the Dedicated Hosts with which the reservation will be associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PurchaseHostReservationRequest withHostIdSet(java.util.Collection hostIdSet) {
setHostIdSet(hostIdSet);
return this;
}
/**
*
* The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's
* upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit,
* the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the
* purchase. At this time, the only supported currency is USD. For example, to indicate a limit price
* of USD 100, specify 100.00.
*
*
* @param limitPrice
* The specified limit is checked against the total upfront cost of the reservation (calculated as the
* offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the
* specified price limit, the request fails. This is used to ensure that the purchase does not exceed the
* expected upfront cost of the purchase. At this time, the only supported currency is USD. For
* example, to indicate a limit price of USD 100, specify 100.00.
*/
public void setLimitPrice(String limitPrice) {
this.limitPrice = limitPrice;
}
/**
*
* The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's
* upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit,
* the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the
* purchase. At this time, the only supported currency is USD. For example, to indicate a limit price
* of USD 100, specify 100.00.
*
*
* @return The specified limit is checked against the total upfront cost of the reservation (calculated as the
* offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the
* specified price limit, the request fails. This is used to ensure that the purchase does not exceed the
* expected upfront cost of the purchase. At this time, the only supported currency is USD. For
* example, to indicate a limit price of USD 100, specify 100.00.
*/
public String getLimitPrice() {
return this.limitPrice;
}
/**
*
* The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's
* upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit,
* the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the
* purchase. At this time, the only supported currency is USD. For example, to indicate a limit price
* of USD 100, specify 100.00.
*
*
* @param limitPrice
* The specified limit is checked against the total upfront cost of the reservation (calculated as the
* offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the
* specified price limit, the request fails. This is used to ensure that the purchase does not exceed the
* expected upfront cost of the purchase. At this time, the only supported currency is USD. For
* example, to indicate a limit price of USD 100, specify 100.00.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PurchaseHostReservationRequest withLimitPrice(String limitPrice) {
setLimitPrice(limitPrice);
return this;
}
/**
*
* The ID of the offering.
*
*
* @param offeringId
* The ID of the offering.
*/
public void setOfferingId(String offeringId) {
this.offeringId = offeringId;
}
/**
*
* The ID of the offering.
*
*
* @return The ID of the offering.
*/
public String getOfferingId() {
return this.offeringId;
}
/**
*
* The ID of the offering.
*
*
* @param offeringId
* The ID of the offering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PurchaseHostReservationRequest withOfferingId(String offeringId) {
setOfferingId(offeringId);
return this;
}
/**
*
* The tags to apply to the Dedicated Host Reservation during purchase.
*
*
* @return The tags to apply to the Dedicated Host Reservation during purchase.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to apply to the Dedicated Host Reservation during purchase.
*
*
* @param tagSpecifications
* The tags to apply to the Dedicated Host Reservation during purchase.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to apply to the Dedicated Host Reservation during purchase.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to apply to the Dedicated Host Reservation during purchase.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PurchaseHostReservationRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to apply to the Dedicated Host Reservation during purchase.
*
*
* @param tagSpecifications
* The tags to apply to the Dedicated Host Reservation during purchase.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PurchaseHostReservationRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new PurchaseHostReservationRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getCurrencyCode() != null)
sb.append("CurrencyCode: ").append(getCurrencyCode()).append(",");
if (getHostIdSet() != null)
sb.append("HostIdSet: ").append(getHostIdSet()).append(",");
if (getLimitPrice() != null)
sb.append("LimitPrice: ").append(getLimitPrice()).append(",");
if (getOfferingId() != null)
sb.append("OfferingId: ").append(getOfferingId()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PurchaseHostReservationRequest == false)
return false;
PurchaseHostReservationRequest other = (PurchaseHostReservationRequest) obj;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == 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.getHostIdSet() == null ^ this.getHostIdSet() == null)
return false;
if (other.getHostIdSet() != null && other.getHostIdSet().equals(this.getHostIdSet()) == false)
return false;
if (other.getLimitPrice() == null ^ this.getLimitPrice() == null)
return false;
if (other.getLimitPrice() != null && other.getLimitPrice().equals(this.getLimitPrice()) == 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.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getCurrencyCode() == null) ? 0 : getCurrencyCode().hashCode());
hashCode = prime * hashCode + ((getHostIdSet() == null) ? 0 : getHostIdSet().hashCode());
hashCode = prime * hashCode + ((getLimitPrice() == null) ? 0 : getLimitPrice().hashCode());
hashCode = prime * hashCode + ((getOfferingId() == null) ? 0 : getOfferingId().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
return hashCode;
}
@Override
public PurchaseHostReservationRequest clone() {
return (PurchaseHostReservationRequest) super.clone();
}
}