@Generated(value="software.amazon.awssdk:codegen") public class HostReservation extends Object implements ToCopyableBuilder<HostReservation.Builder,HostReservation>
Details about the Dedicated Host Reservation and associated Dedicated Hosts.
Modifier and Type | Class and Description |
---|---|
static interface |
HostReservation.Builder |
Modifier and Type | Method and Description |
---|---|
static HostReservation.Builder |
builder() |
Integer |
count()
The number of Dedicated Hosts the reservation is associated with.
|
CurrencyCodeValues |
currencyCode()
The currency in which the
upfrontPrice and hourlyPrice amounts are specified. |
String |
currencyCodeString()
The currency in which the
upfrontPrice and hourlyPrice amounts are specified. |
Integer |
duration()
The length of the reservation's term, specified in seconds.
|
Instant |
end()
The date and time that the reservation ends.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<String> |
hostIdSet()
The IDs of the Dedicated Hosts associated with the reservation.
|
String |
hostReservationId()
The ID of the reservation that specifies the associated Dedicated Hosts.
|
String |
hourlyPrice()
The hourly price of the reservation.
|
String |
instanceFamily()
The instance family of the Dedicated Host Reservation.
|
String |
offeringId()
The ID of the reservation.
|
PaymentOption |
paymentOption()
The payment option selected for this reservation.
|
String |
paymentOptionString()
The payment option selected for this reservation.
|
static Class<? extends HostReservation.Builder> |
serializableBuilderClass() |
Instant |
start()
The date and time that the reservation started.
|
ReservationState |
state()
The state of the reservation.
|
String |
stateString()
The state of the reservation.
|
HostReservation.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
upfrontPrice()
The upfront price of the reservation.
|
copy
public Integer count()
The number of Dedicated Hosts the reservation is associated with.
public CurrencyCodeValues currencyCode()
The currency in which the upfrontPrice
and hourlyPrice
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
currencyCodeString()
.
upfrontPrice
and hourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.CurrencyCodeValues
public String currencyCodeString()
The currency in which the upfrontPrice
and hourlyPrice
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
currencyCodeString()
.
upfrontPrice
and hourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.CurrencyCodeValues
public Integer duration()
The length of the reservation's term, specified in seconds. Can be 31536000 (1 year)
|
94608000 (3 years)
.
31536000 (1 year)
|
94608000 (3 years)
.public Instant end()
The date and time that the reservation ends.
public List<String> hostIdSet()
The IDs of the Dedicated Hosts associated with the reservation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String hostReservationId()
The ID of the reservation that specifies the associated Dedicated Hosts.
public String hourlyPrice()
The hourly price of the reservation.
public String 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 String offeringId()
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
public PaymentOption paymentOption()
The payment option selected for this reservation.
If the service returns an enum value that is not available in the current SDK version, paymentOption
will return PaymentOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
paymentOptionString()
.
PaymentOption
public String paymentOptionString()
The payment option selected for this reservation.
If the service returns an enum value that is not available in the current SDK version, paymentOption
will return PaymentOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
paymentOptionString()
.
PaymentOption
public Instant start()
The date and time that the reservation started.
public ReservationState state()
The state of the reservation.
If the service returns an enum value that is not available in the current SDK version, state
will return
ReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
ReservationState
public String stateString()
The state of the reservation.
If the service returns an enum value that is not available in the current SDK version, state
will return
ReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
ReservationState
public String upfrontPrice()
The upfront price of the reservation.
public HostReservation.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<HostReservation.Builder,HostReservation>
public static HostReservation.Builder builder()
public static Class<? extends HostReservation.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.