software.amazon.awssdk.services.ec2.model

Class PurchaseHostReservationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.PurchaseHostReservationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PurchaseHostReservationRequest.Builder,PurchaseHostReservationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PurchaseHostReservationRequest
extends Ec2Request
implements ToCopyableBuilder<PurchaseHostReservationRequest.Builder,PurchaseHostReservationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PurchaseHostReservationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PurchaseHostReservationRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
CurrencyCodeValues	currencyCode() The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified.
String	currencyCodeAsString() The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<String>	hostIdSet() The IDs of the Dedicated Hosts with which the reservation will be associated.
String	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).
String	offeringId() The ID of the offering.
List<SdkField<?>>	sdkFields()
static Class<? extends PurchaseHostReservationRequest.Builder>	serializableBuilderClass()
PurchaseHostReservationRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientToken

public String clientToken()

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Returns:

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

currencyCode

public CurrencyCodeValues currencyCode()

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

If the service returns an enum value that is not available in the current SDK version, currencyCode will return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeAsString().

Returns:

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

See Also:

CurrencyCodeValues

currencyCodeAsString

public String currencyCodeAsString()

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

If the service returns an enum value that is not available in the current SDK version, currencyCode will return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeAsString().

Returns:

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

See Also:

CurrencyCodeValues

hostIdSet

public List<String> hostIdSet()

The IDs of the Dedicated Hosts with which the reservation will be associated.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The IDs of the Dedicated Hosts with which the reservation will be associated.

limitPrice

public String 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.

Returns:

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.

offeringId

public String offeringId()

The ID of the offering.

Returns:

The ID of the offering.

toBuilder

public PurchaseHostReservationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PurchaseHostReservationRequest.Builder,PurchaseHostReservationRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static PurchaseHostReservationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PurchaseHostReservationRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo