java.lang.Object
- software.amazon.awssdk.services.ec2.model.HostReservation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HostReservation.Builder,HostReservation>
```
@Generated("software.amazon.awssdk:codegen")
public final class HostReservation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HostReservation.Builder,HostReservation>
```
Details about the Dedicated Host Reservation and associated Dedicated Hosts.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface HostReservation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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`	`currencyCodeAsString()`	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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasHostIdSet()`	For responses, this returns true if the service returned a value for the HostIdSet property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`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`	`paymentOptionAsString()`	The payment option selected for this reservation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HostReservation.Builder>`	`serializableBuilderClass()`
`Instant`	`start()`	The date and time that the reservation started.
`ReservationState`	`state()`	The state of the reservation.
`String`	`stateAsString()`	The state of the reservation.
`List<Tag>`	`tags()`	Any tags assigned to the Dedicated Host Reservation.
`HostReservation.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`upfrontPrice()`	The upfront price of the reservation.

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
  - count
```
public final Integer count()
```
    The number of Dedicated Hosts the reservation is associated with.
    
    Returns:
    
    The number of Dedicated Hosts the reservation is associated with.
  - currencyCode
```
public final 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 currencyCodeAsString().
    
    Returns:
    
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    See Also:
    
    CurrencyCodeValues
  - currencyCodeAsString
```
public final String currencyCodeAsString()
```
    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 currencyCodeAsString().
    
    Returns:
    
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    See Also:
    
    CurrencyCodeValues
  - duration
```
public final Integer duration()
```
    The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
    
    Returns:
    
    The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
  - end
```
public final Instant end()
```
    The date and time that the reservation ends.
    
    Returns:
    
    The date and time that the reservation ends.
  - hasHostIdSet
```
public final boolean hasHostIdSet()
```
    For responses, this returns true if the service returned a value for the HostIdSet property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - hostIdSet
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHostIdSet() method.
    
    Returns:
    
    The IDs of the Dedicated Hosts associated with the reservation.
  - hostReservationId
```
public final String hostReservationId()
```
    The ID of the reservation that specifies the associated Dedicated Hosts.
    
    Returns:
    
    The ID of the reservation that specifies the associated Dedicated Hosts.
  - hourlyPrice
```
public final String hourlyPrice()
```
    The hourly price of the reservation.
    
    Returns:
    
    The hourly price of the reservation.
  - instanceFamily
```
public final 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.
    
    Returns:
    
    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.
  - offeringId
```
public final String offeringId()
```
    The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
    
    Returns:
    
    The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
  - paymentOption
```
public final 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 paymentOptionAsString().
    
    Returns:
    
    The payment option selected for this reservation.
    
    See Also:
    
    PaymentOption
  - paymentOptionAsString
```
public final String paymentOptionAsString()
```
    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 paymentOptionAsString().
    
    Returns:
    
    The payment option selected for this reservation.
    
    See Also:
    
    PaymentOption
  - start
```
public final Instant start()
```
    The date and time that the reservation started.
    
    Returns:
    
    The date and time that the reservation started.
  - state
```
public final 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 stateAsString().
    
    Returns:
    
    The state of the reservation.
    
    See Also:
    
    ReservationState
  - stateAsString
```
public final String stateAsString()
```
    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 stateAsString().
    
    Returns:
    
    The state of the reservation.
    
    See Also:
    
    ReservationState
  - upfrontPrice
```
public final String upfrontPrice()
```
    The upfront price of the reservation.
    
    Returns:
    
    The upfront price of the reservation.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    Any tags assigned to the Dedicated Host Reservation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    Any tags assigned to the Dedicated Host Reservation.
  - toBuilder
```
public HostReservation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<HostReservation.Builder,HostReservation>
  - builder
```
public static HostReservation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HostReservation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class HostReservation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

count

currencyCode

currencyCodeAsString

duration

end

hasHostIdSet

hostIdSet

hostReservationId

hourlyPrice

instanceFamily

offeringId

paymentOption

paymentOptionAsString

start

state

stateAsString

upfrontPrice

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields