HostReservation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.HostReservation

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HostReservation
extends Object
implements Serializable, Cloneable
```
Details about the Dedicated Host Reservation and associated Dedicated Hosts.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HostReservation()

Constructors
Constructor and Description
`HostReservation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HostReservation`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getCount()` The number of Dedicated Hosts the reservation is associated with.
`String`	`getCurrencyCode()` The currency in which the `upfrontPrice` and `hourlyPrice` amounts are specified.
`Integer`	`getDuration()` The length of the reservation's term, specified in seconds.
`Date`	`getEnd()` The date and time that the reservation ends.
`List<String>`	`getHostIdSet()` The IDs of the Dedicated Hosts associated with the reservation.
`String`	`getHostReservationId()` The ID of the reservation that specifies the associated Dedicated Hosts.
`String`	`getHourlyPrice()` The hourly price of the reservation.
`String`	`getInstanceFamily()` The instance family of the Dedicated Host Reservation.
`String`	`getOfferingId()` The ID of the reservation.
`String`	`getPaymentOption()` The payment option selected for this reservation.
`Date`	`getStart()` The date and time that the reservation started.
`String`	`getState()` The state of the reservation.
`String`	`getUpfrontPrice()` The upfront price of the reservation.
`int`	`hashCode()`
`void`	`setCount(Integer count)` The number of Dedicated Hosts the reservation is associated with.
`void`	`setCurrencyCode(CurrencyCodeValues currencyCode)` The currency in which the `upfrontPrice` and `hourlyPrice` amounts are specified.
`void`	`setCurrencyCode(String currencyCode)` The currency in which the `upfrontPrice` and `hourlyPrice` amounts are specified.
`void`	`setDuration(Integer duration)` The length of the reservation's term, specified in seconds.
`void`	`setEnd(Date end)` The date and time that the reservation ends.
`void`	`setHostIdSet(Collection<String> hostIdSet)` The IDs of the Dedicated Hosts associated with the reservation.
`void`	`setHostReservationId(String hostReservationId)` The ID of the reservation that specifies the associated Dedicated Hosts.
`void`	`setHourlyPrice(String hourlyPrice)` The hourly price of the reservation.
`void`	`setInstanceFamily(String instanceFamily)` The instance family of the Dedicated Host Reservation.
`void`	`setOfferingId(String offeringId)` The ID of the reservation.
`void`	`setPaymentOption(PaymentOption paymentOption)` The payment option selected for this reservation.
`void`	`setPaymentOption(String paymentOption)` The payment option selected for this reservation.
`void`	`setStart(Date start)` The date and time that the reservation started.
`void`	`setState(ReservationState state)` The state of the reservation.
`void`	`setState(String state)` The state of the reservation.
`void`	`setUpfrontPrice(String upfrontPrice)` The upfront price of the reservation.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`HostReservation`	`withCount(Integer count)` The number of Dedicated Hosts the reservation is associated with.
`HostReservation`	`withCurrencyCode(CurrencyCodeValues currencyCode)` The currency in which the `upfrontPrice` and `hourlyPrice` amounts are specified.
`HostReservation`	`withCurrencyCode(String currencyCode)` The currency in which the `upfrontPrice` and `hourlyPrice` amounts are specified.
`HostReservation`	`withDuration(Integer duration)` The length of the reservation's term, specified in seconds.
`HostReservation`	`withEnd(Date end)` The date and time that the reservation ends.
`HostReservation`	`withHostIdSet(Collection<String> hostIdSet)` The IDs of the Dedicated Hosts associated with the reservation.
`HostReservation`	`withHostIdSet(String... hostIdSet)` The IDs of the Dedicated Hosts associated with the reservation.
`HostReservation`	`withHostReservationId(String hostReservationId)` The ID of the reservation that specifies the associated Dedicated Hosts.
`HostReservation`	`withHourlyPrice(String hourlyPrice)` The hourly price of the reservation.
`HostReservation`	`withInstanceFamily(String instanceFamily)` The instance family of the Dedicated Host Reservation.
`HostReservation`	`withOfferingId(String offeringId)` The ID of the reservation.
`HostReservation`	`withPaymentOption(PaymentOption paymentOption)` The payment option selected for this reservation.
`HostReservation`	`withPaymentOption(String paymentOption)` The payment option selected for this reservation.
`HostReservation`	`withStart(Date start)` The date and time that the reservation started.
`HostReservation`	`withState(ReservationState state)` The state of the reservation.
`HostReservation`	`withState(String state)` The state of the reservation.
`HostReservation`	`withUpfrontPrice(String upfrontPrice)` The upfront price of the reservation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HostReservation
```
public HostReservation()
```
- Method Detail
  - setCount
```
public void setCount(Integer count)
```
    The number of Dedicated Hosts the reservation is associated with.
    
    Parameters:
    
    count - The number of Dedicated Hosts the reservation is associated with.
  - getCount
```
public Integer getCount()
```
    The number of Dedicated Hosts the reservation is associated with.
    
    Returns:
    
    The number of Dedicated Hosts the reservation is associated with.
  - withCount
```
public HostReservation withCount(Integer count)
```
    The number of Dedicated Hosts the reservation is associated with.
    
    Parameters:
    
    count - The number of Dedicated Hosts the reservation is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrencyCode
```
public void setCurrencyCode(String currencyCode)
```
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    Parameters:
    
    currencyCode - The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    See Also:
    
    CurrencyCodeValues
  - getCurrencyCode
```
public String getCurrencyCode()
```
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    Returns:
    
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    See Also:
    
    CurrencyCodeValues
  - withCurrencyCode
```
public HostReservation withCurrencyCode(String currencyCode)
```
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    Parameters:
    
    currencyCode - The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CurrencyCodeValues
  - setCurrencyCode
```
public void setCurrencyCode(CurrencyCodeValues currencyCode)
```
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    Parameters:
    
    currencyCode - The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    See Also:
    
    CurrencyCodeValues
  - withCurrencyCode
```
public HostReservation withCurrencyCode(CurrencyCodeValues currencyCode)
```
    The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    Parameters:
    
    currencyCode - The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CurrencyCodeValues
  - setDuration
```
public void setDuration(Integer duration)
```
    The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
    
    Parameters:
    
    duration - The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
  - getDuration
```
public Integer getDuration()
```
    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).
  - withDuration
```
public HostReservation withDuration(Integer duration)
```
    The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
    
    Parameters:
    
    duration - The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnd
```
public void setEnd(Date end)
```
    The date and time that the reservation ends.
    
    Parameters:
    
    end - The date and time that the reservation ends.
  - getEnd
```
public Date getEnd()
```
    The date and time that the reservation ends.
    
    Returns:
    
    The date and time that the reservation ends.
  - withEnd
```
public HostReservation withEnd(Date end)
```
    The date and time that the reservation ends.
    
    Parameters:
    
    end - The date and time that the reservation ends.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHostIdSet
```
public List<String> getHostIdSet()
```
    The IDs of the Dedicated Hosts associated with the reservation.
    
    Returns:
    
    The IDs of the Dedicated Hosts associated with the reservation.
  - setHostIdSet
```
public void setHostIdSet(Collection<String> hostIdSet)
```
    The IDs of the Dedicated Hosts associated with the reservation.
    
    Parameters:
    
    hostIdSet - The IDs of the Dedicated Hosts associated with the reservation.
  - withHostIdSet
```
public HostReservation withHostIdSet(String... hostIdSet)
```
    The IDs of the Dedicated Hosts associated with the reservation.
    
    NOTE: This method appends the values to the existing list (if any). Use setHostIdSet(java.util.Collection) or withHostIdSet(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    hostIdSet - The IDs of the Dedicated Hosts associated with the reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHostIdSet
```
public HostReservation withHostIdSet(Collection<String> hostIdSet)
```
    The IDs of the Dedicated Hosts associated with the reservation.
    
    Parameters:
    
    hostIdSet - The IDs of the Dedicated Hosts associated with the reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostReservationId
```
public void setHostReservationId(String hostReservationId)
```
    The ID of the reservation that specifies the associated Dedicated Hosts.
    
    Parameters:
    
    hostReservationId - The ID of the reservation that specifies the associated Dedicated Hosts.
  - getHostReservationId
```
public String getHostReservationId()
```
    The ID of the reservation that specifies the associated Dedicated Hosts.
    
    Returns:
    
    The ID of the reservation that specifies the associated Dedicated Hosts.
  - withHostReservationId
```
public HostReservation withHostReservationId(String hostReservationId)
```
    The ID of the reservation that specifies the associated Dedicated Hosts.
    
    Parameters:
    
    hostReservationId - The ID of the reservation that specifies the associated Dedicated Hosts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHourlyPrice
```
public void setHourlyPrice(String hourlyPrice)
```
    The hourly price of the reservation.
    
    Parameters:
    
    hourlyPrice - The hourly price of the reservation.
  - getHourlyPrice
```
public String getHourlyPrice()
```
    The hourly price of the reservation.
    
    Returns:
    
    The hourly price of the reservation.
  - withHourlyPrice
```
public HostReservation withHourlyPrice(String hourlyPrice)
```
    The hourly price of the reservation.
    
    Parameters:
    
    hourlyPrice - The hourly price of the reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceFamily
```
public void setInstanceFamily(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.
    
    Parameters:
    
    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.
  - getInstanceFamily
```
public String getInstanceFamily()
```
    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.
  - withInstanceFamily
```
public HostReservation withInstanceFamily(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOfferingId
```
public void setOfferingId(String offeringId)
```
    The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
    
    Parameters:
    
    offeringId - The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
  - getOfferingId
```
public String getOfferingId()
```
    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.
  - withOfferingId
```
public HostReservation withOfferingId(String offeringId)
```
    The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
    
    Parameters:
    
    offeringId - The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPaymentOption
```
public void setPaymentOption(String paymentOption)
```
    The payment option selected for this reservation.
    
    Parameters:
    
    paymentOption - The payment option selected for this reservation.
    
    See Also:
    
    PaymentOption
  - getPaymentOption
```
public String getPaymentOption()
```
    The payment option selected for this reservation.
    
    Returns:
    
    The payment option selected for this reservation.
    
    See Also:
    
    PaymentOption
  - withPaymentOption
```
public HostReservation withPaymentOption(String paymentOption)
```
    The payment option selected for this reservation.
    
    Parameters:
    
    paymentOption - The payment option selected for this reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PaymentOption
  - setPaymentOption
```
public void setPaymentOption(PaymentOption paymentOption)
```
    The payment option selected for this reservation.
    
    Parameters:
    
    paymentOption - The payment option selected for this reservation.
    
    See Also:
    
    PaymentOption
  - withPaymentOption
```
public HostReservation withPaymentOption(PaymentOption paymentOption)
```
    The payment option selected for this reservation.
    
    Parameters:
    
    paymentOption - The payment option selected for this reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PaymentOption
  - setStart
```
public void setStart(Date start)
```
    The date and time that the reservation started.
    
    Parameters:
    
    start - The date and time that the reservation started.
  - getStart
```
public Date getStart()
```
    The date and time that the reservation started.
    
    Returns:
    
    The date and time that the reservation started.
  - withStart
```
public HostReservation withStart(Date start)
```
    The date and time that the reservation started.
    
    Parameters:
    
    start - The date and time that the reservation started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the reservation.
    
    Parameters:
    
    state - The state of the reservation.
    
    See Also:
    
    ReservationState
  - getState
```
public String getState()
```
    The state of the reservation.
    
    Returns:
    
    The state of the reservation.
    
    See Also:
    
    ReservationState
  - withState
```
public HostReservation withState(String state)
```
    The state of the reservation.
    
    Parameters:
    
    state - The state of the reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReservationState
  - setState
```
public void setState(ReservationState state)
```
    The state of the reservation.
    
    Parameters:
    
    state - The state of the reservation.
    
    See Also:
    
    ReservationState
  - withState
```
public HostReservation withState(ReservationState state)
```
    The state of the reservation.
    
    Parameters:
    
    state - The state of the reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReservationState
  - setUpfrontPrice
```
public void setUpfrontPrice(String upfrontPrice)
```
    The upfront price of the reservation.
    
    Parameters:
    
    upfrontPrice - The upfront price of the reservation.
  - getUpfrontPrice
```
public String getUpfrontPrice()
```
    The upfront price of the reservation.
    
    Returns:
    
    The upfront price of the reservation.
  - withUpfrontPrice
```
public HostReservation withUpfrontPrice(String upfrontPrice)
```
    The upfront price of the reservation.
    
    Parameters:
    
    upfrontPrice - The upfront price of the reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HostReservation clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class HostReservation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HostReservation

Method Detail

setCount

getCount

withCount

setCurrencyCode

getCurrencyCode

withCurrencyCode

setCurrencyCode

withCurrencyCode

setDuration

getDuration

withDuration

setEnd

getEnd

withEnd

getHostIdSet

setHostIdSet

withHostIdSet

withHostIdSet

setHostReservationId

getHostReservationId

withHostReservationId

setHourlyPrice

getHourlyPrice

withHourlyPrice

setInstanceFamily

getInstanceFamily

withInstanceFamily

setOfferingId

getOfferingId

withOfferingId

setPaymentOption

getPaymentOption

withPaymentOption

setPaymentOption

withPaymentOption

setStart

getStart

withStart

setState

getState

withState

setState

withState

setUpfrontPrice

getUpfrontPrice

withUpfrontPrice

toString

equals

hashCode

clone