ReservedInstance (AWS Java SDK for Amazon OpenSearch 1.12.336 API)

java.lang.Object
- com.amazonaws.services.opensearch.model.ReservedInstance

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReservedInstance
extends Object
implements Serializable, Cloneable, StructuredPojo

Details of a reserved OpenSearch instance.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReservedInstance()

Constructors
Constructor and Description
`ReservedInstance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReservedInstance`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getBillingSubscriptionId()`
`String`	`getCurrencyCode()` The currency code for the reserved OpenSearch instance offering.
`Integer`	`getDuration()` The duration, in seconds, for which the OpenSearch instance is reserved.
`Double`	`getFixedPrice()` The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
`Integer`	`getInstanceCount()` The number of OpenSearch instances that have been reserved.
`String`	`getInstanceType()` The OpenSearch instance type offered by the reserved instance offering.
`String`	`getPaymentOption()` The payment option as defined in the reserved OpenSearch instance offering.
`List<RecurringCharge>`	`getRecurringCharges()` The charge to your account regardless of whether you are creating any domains using the instance offering.
`String`	`getReservationName()` The customer-specified identifier to track this reservation.
`String`	`getReservedInstanceId()` The unique identifier for the reservation.
`String`	`getReservedInstanceOfferingId()` The offering identifier.
`Date`	`getStartTime()` The time the reservation started.
`String`	`getState()` The state of the reserved OpenSearch instance.
`Double`	`getUsagePrice()` The rate you are charged for each hour for the domain that is using this reserved instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBillingSubscriptionId(Long billingSubscriptionId)`
`void`	`setCurrencyCode(String currencyCode)` The currency code for the reserved OpenSearch instance offering.
`void`	`setDuration(Integer duration)` The duration, in seconds, for which the OpenSearch instance is reserved.
`void`	`setFixedPrice(Double fixedPrice)` The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
`void`	`setInstanceCount(Integer instanceCount)` The number of OpenSearch instances that have been reserved.
`void`	`setInstanceType(String instanceType)` The OpenSearch instance type offered by the reserved instance offering.
`void`	`setPaymentOption(String paymentOption)` The payment option as defined in the reserved OpenSearch instance offering.
`void`	`setRecurringCharges(Collection<RecurringCharge> recurringCharges)` The charge to your account regardless of whether you are creating any domains using the instance offering.
`void`	`setReservationName(String reservationName)` The customer-specified identifier to track this reservation.
`void`	`setReservedInstanceId(String reservedInstanceId)` The unique identifier for the reservation.
`void`	`setReservedInstanceOfferingId(String reservedInstanceOfferingId)` The offering identifier.
`void`	`setStartTime(Date startTime)` The time the reservation started.
`void`	`setState(String state)` The state of the reserved OpenSearch instance.
`void`	`setUsagePrice(Double usagePrice)` The rate you are charged for each hour for the domain that is using this reserved instance.
`String`	`toString()` Returns a string representation of this object.
`ReservedInstance`	`withBillingSubscriptionId(Long billingSubscriptionId)`
`ReservedInstance`	`withCurrencyCode(String currencyCode)` The currency code for the reserved OpenSearch instance offering.
`ReservedInstance`	`withDuration(Integer duration)` The duration, in seconds, for which the OpenSearch instance is reserved.
`ReservedInstance`	`withFixedPrice(Double fixedPrice)` The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
`ReservedInstance`	`withInstanceCount(Integer instanceCount)` The number of OpenSearch instances that have been reserved.
`ReservedInstance`	`withInstanceType(OpenSearchPartitionInstanceType instanceType)` The OpenSearch instance type offered by the reserved instance offering.
`ReservedInstance`	`withInstanceType(String instanceType)` The OpenSearch instance type offered by the reserved instance offering.
`ReservedInstance`	`withPaymentOption(ReservedInstancePaymentOption paymentOption)` The payment option as defined in the reserved OpenSearch instance offering.
`ReservedInstance`	`withPaymentOption(String paymentOption)` The payment option as defined in the reserved OpenSearch instance offering.
`ReservedInstance`	`withRecurringCharges(Collection<RecurringCharge> recurringCharges)` The charge to your account regardless of whether you are creating any domains using the instance offering.
`ReservedInstance`	`withRecurringCharges(RecurringCharge... recurringCharges)` The charge to your account regardless of whether you are creating any domains using the instance offering.
`ReservedInstance`	`withReservationName(String reservationName)` The customer-specified identifier to track this reservation.
`ReservedInstance`	`withReservedInstanceId(String reservedInstanceId)` The unique identifier for the reservation.
`ReservedInstance`	`withReservedInstanceOfferingId(String reservedInstanceOfferingId)` The offering identifier.
`ReservedInstance`	`withStartTime(Date startTime)` The time the reservation started.
`ReservedInstance`	`withState(String state)` The state of the reserved OpenSearch instance.
`ReservedInstance`	`withUsagePrice(Double usagePrice)` The rate you are charged for each hour for the domain that is using this reserved instance.

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

- Constructor Detail
  - ReservedInstance
```
public ReservedInstance()
```
- Method Detail
  - setReservationName
```
public void setReservationName(String reservationName)
```
    The customer-specified identifier to track this reservation.
    
    Parameters:
    
    reservationName - The customer-specified identifier to track this reservation.
  - getReservationName
```
public String getReservationName()
```
    The customer-specified identifier to track this reservation.
    
    Returns:
    
    The customer-specified identifier to track this reservation.
  - withReservationName
```
public ReservedInstance withReservationName(String reservationName)
```
    The customer-specified identifier to track this reservation.
    
    Parameters:
    
    reservationName - The customer-specified identifier to track this reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReservedInstanceId
```
public void setReservedInstanceId(String reservedInstanceId)
```
    The unique identifier for the reservation.
    
    Parameters:
    
    reservedInstanceId - The unique identifier for the reservation.
  - getReservedInstanceId
```
public String getReservedInstanceId()
```
    The unique identifier for the reservation.
    
    Returns:
    
    The unique identifier for the reservation.
  - withReservedInstanceId
```
public ReservedInstance withReservedInstanceId(String reservedInstanceId)
```
    The unique identifier for the reservation.
    
    Parameters:
    
    reservedInstanceId - The unique identifier for the reservation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBillingSubscriptionId
```
public void setBillingSubscriptionId(Long billingSubscriptionId)
```
    Parameters:
    
    billingSubscriptionId -
  - getBillingSubscriptionId
```
public Long getBillingSubscriptionId()
```
    Returns:
  - withBillingSubscriptionId
```
public ReservedInstance withBillingSubscriptionId(Long billingSubscriptionId)
```
    Parameters:
    
    billingSubscriptionId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReservedInstanceOfferingId
```
public void setReservedInstanceOfferingId(String reservedInstanceOfferingId)
```
    The offering identifier.
    
    Parameters:
    
    reservedInstanceOfferingId - The offering identifier.
  - getReservedInstanceOfferingId
```
public String getReservedInstanceOfferingId()
```
    The offering identifier.
    
    Returns:
    
    The offering identifier.
  - withReservedInstanceOfferingId
```
public ReservedInstance withReservedInstanceOfferingId(String reservedInstanceOfferingId)
```
    The offering identifier.
    
    Parameters:
    
    reservedInstanceOfferingId - The offering identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The OpenSearch instance type offered by the reserved instance offering.
    
    Parameters:
    
    instanceType - The OpenSearch instance type offered by the reserved instance offering.
    
    See Also:
    
    OpenSearchPartitionInstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The OpenSearch instance type offered by the reserved instance offering.
    
    Returns:
    
    The OpenSearch instance type offered by the reserved instance offering.
    
    See Also:
    
    OpenSearchPartitionInstanceType
  - withInstanceType
```
public ReservedInstance withInstanceType(String instanceType)
```
    The OpenSearch instance type offered by the reserved instance offering.
    
    Parameters:
    
    instanceType - The OpenSearch instance type offered by the reserved instance offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpenSearchPartitionInstanceType
  - withInstanceType
```
public ReservedInstance withInstanceType(OpenSearchPartitionInstanceType instanceType)
```
    The OpenSearch instance type offered by the reserved instance offering.
    
    Parameters:
    
    instanceType - The OpenSearch instance type offered by the reserved instance offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpenSearchPartitionInstanceType
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The time the reservation started.
    
    Parameters:
    
    startTime - The time the reservation started.
  - getStartTime
```
public Date getStartTime()
```
    The time the reservation started.
    
    Returns:
    
    The time the reservation started.
  - withStartTime
```
public ReservedInstance withStartTime(Date startTime)
```
    The time the reservation started.
    
    Parameters:
    
    startTime - The time the reservation started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDuration
```
public void setDuration(Integer duration)
```
    The duration, in seconds, for which the OpenSearch instance is reserved.
    
    Parameters:
    
    duration - The duration, in seconds, for which the OpenSearch instance is reserved.
  - getDuration
```
public Integer getDuration()
```
    The duration, in seconds, for which the OpenSearch instance is reserved.
    
    Returns:
    
    The duration, in seconds, for which the OpenSearch instance is reserved.
  - withDuration
```
public ReservedInstance withDuration(Integer duration)
```
    The duration, in seconds, for which the OpenSearch instance is reserved.
    
    Parameters:
    
    duration - The duration, in seconds, for which the OpenSearch instance is reserved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFixedPrice
```
public void setFixedPrice(Double fixedPrice)
```
    The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
    
    Parameters:
    
    fixedPrice - The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
  - getFixedPrice
```
public Double getFixedPrice()
```
    The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
    
    Returns:
    
    The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
  - withFixedPrice
```
public ReservedInstance withFixedPrice(Double fixedPrice)
```
    The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
    
    Parameters:
    
    fixedPrice - The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsagePrice
```
public void setUsagePrice(Double usagePrice)
```
    The rate you are charged for each hour for the domain that is using this reserved instance.
    
    Parameters:
    
    usagePrice - The rate you are charged for each hour for the domain that is using this reserved instance.
  - getUsagePrice
```
public Double getUsagePrice()
```
    The rate you are charged for each hour for the domain that is using this reserved instance.
    
    Returns:
    
    The rate you are charged for each hour for the domain that is using this reserved instance.
  - withUsagePrice
```
public ReservedInstance withUsagePrice(Double usagePrice)
```
    The rate you are charged for each hour for the domain that is using this reserved instance.
    
    Parameters:
    
    usagePrice - The rate you are charged for each hour for the domain that is using this reserved instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrencyCode
```
public void setCurrencyCode(String currencyCode)
```
    The currency code for the reserved OpenSearch instance offering.
    
    Parameters:
    
    currencyCode - The currency code for the reserved OpenSearch instance offering.
  - getCurrencyCode
```
public String getCurrencyCode()
```
    The currency code for the reserved OpenSearch instance offering.
    
    Returns:
    
    The currency code for the reserved OpenSearch instance offering.
  - withCurrencyCode
```
public ReservedInstance withCurrencyCode(String currencyCode)
```
    The currency code for the reserved OpenSearch instance offering.
    
    Parameters:
    
    currencyCode - The currency code for the reserved OpenSearch instance offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceCount
```
public void setInstanceCount(Integer instanceCount)
```
    The number of OpenSearch instances that have been reserved.
    
    Parameters:
    
    instanceCount - The number of OpenSearch instances that have been reserved.
  - getInstanceCount
```
public Integer getInstanceCount()
```
    The number of OpenSearch instances that have been reserved.
    
    Returns:
    
    The number of OpenSearch instances that have been reserved.
  - withInstanceCount
```
public ReservedInstance withInstanceCount(Integer instanceCount)
```
    The number of OpenSearch instances that have been reserved.
    
    Parameters:
    
    instanceCount - The number of OpenSearch instances that have been reserved.
    
    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 reserved OpenSearch instance.
    
    Parameters:
    
    state - The state of the reserved OpenSearch instance.
  - getState
```
public String getState()
```
    The state of the reserved OpenSearch instance.
    
    Returns:
    
    The state of the reserved OpenSearch instance.
  - withState
```
public ReservedInstance withState(String state)
```
    The state of the reserved OpenSearch instance.
    
    Parameters:
    
    state - The state of the reserved OpenSearch instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPaymentOption
```
public void setPaymentOption(String paymentOption)
```
    The payment option as defined in the reserved OpenSearch instance offering.
    
    Parameters:
    
    paymentOption - The payment option as defined in the reserved OpenSearch instance offering.
    
    See Also:
    
    ReservedInstancePaymentOption
  - getPaymentOption
```
public String getPaymentOption()
```
    The payment option as defined in the reserved OpenSearch instance offering.
    
    Returns:
    
    The payment option as defined in the reserved OpenSearch instance offering.
    
    See Also:
    
    ReservedInstancePaymentOption
  - withPaymentOption
```
public ReservedInstance withPaymentOption(String paymentOption)
```
    The payment option as defined in the reserved OpenSearch instance offering.
    
    Parameters:
    
    paymentOption - The payment option as defined in the reserved OpenSearch instance offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReservedInstancePaymentOption
  - withPaymentOption
```
public ReservedInstance withPaymentOption(ReservedInstancePaymentOption paymentOption)
```
    The payment option as defined in the reserved OpenSearch instance offering.
    
    Parameters:
    
    paymentOption - The payment option as defined in the reserved OpenSearch instance offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReservedInstancePaymentOption
  - getRecurringCharges
```
public List<RecurringCharge> getRecurringCharges()
```
    The charge to your account regardless of whether you are creating any domains using the instance offering.
    
    Returns:
    
    The charge to your account regardless of whether you are creating any domains using the instance offering.
  - setRecurringCharges
```
public void setRecurringCharges(Collection<RecurringCharge> recurringCharges)
```
    The charge to your account regardless of whether you are creating any domains using the instance offering.
    
    Parameters:
    
    recurringCharges - The charge to your account regardless of whether you are creating any domains using the instance offering.
  - withRecurringCharges
```
public ReservedInstance withRecurringCharges(RecurringCharge... recurringCharges)
```
    The charge to your account regardless of whether you are creating any domains using the instance offering.
    
    NOTE: This method appends the values to the existing list (if any). Use setRecurringCharges(java.util.Collection) or withRecurringCharges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    recurringCharges - The charge to your account regardless of whether you are creating any domains using the instance offering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRecurringCharges
```
public ReservedInstance withRecurringCharges(Collection<RecurringCharge> recurringCharges)
```
    The charge to your account regardless of whether you are creating any domains using the instance offering.
    
    Parameters:
    
    recurringCharges - The charge to your account regardless of whether you are creating any domains using the instance offering.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 ReservedInstance clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ReservedInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReservedInstance

Method Detail

setReservationName

getReservationName

withReservationName

setReservedInstanceId

getReservedInstanceId

withReservedInstanceId

setBillingSubscriptionId

getBillingSubscriptionId

withBillingSubscriptionId

setReservedInstanceOfferingId

getReservedInstanceOfferingId

withReservedInstanceOfferingId

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setStartTime

getStartTime

withStartTime

setDuration

getDuration

withDuration

setFixedPrice

getFixedPrice

withFixedPrice

setUsagePrice

getUsagePrice

withUsagePrice

setCurrencyCode

getCurrencyCode

withCurrencyCode

setInstanceCount

getInstanceCount

withInstanceCount

setState

getState

withState

setPaymentOption

getPaymentOption

withPaymentOption

withPaymentOption

getRecurringCharges

setRecurringCharges

withRecurringCharges

withRecurringCharges

toString

equals

hashCode

clone

marshall