java.lang.Object
- software.amazon.awssdk.services.opensearch.model.ReservedInstance

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ReservedInstance.Builder,ReservedInstance>

@Generated("software.amazon.awssdk:codegen")
public final class ReservedInstance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReservedInstance.Builder,ReservedInstance>

Details of an OpenSearch Reserved Instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ReservedInstance.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Long`	`billingSubscriptionId()`	The unique identifier of the billing subscription.
`static ReservedInstance.Builder`	`builder()`
`String`	`currencyCode()`	The currency code for the offering.
`Integer`	`duration()`	The duration, in seconds, for which the OpenSearch instance is reserved.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Double`	`fixedPrice()`	The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRecurringCharges()`	For responses, this returns true if the service returned a value for the RecurringCharges property.
`Integer`	`instanceCount()`	The number of OpenSearch instances that have been reserved.
`OpenSearchPartitionInstanceType`	`instanceType()`	The OpenSearch instance type offered by theReserved Instance offering.
`String`	`instanceTypeAsString()`	The OpenSearch instance type offered by theReserved Instance offering.
`ReservedInstancePaymentOption`	`paymentOption()`	The payment option as defined in the Reserved Instance offering.
`String`	`paymentOptionAsString()`	The payment option as defined in the Reserved Instance offering.
`List<RecurringCharge>`	`recurringCharges()`	The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
`String`	`reservationName()`	The customer-specified identifier to track this reservation.
`String`	`reservedInstanceId()`	The unique identifier for the reservation.
`String`	`reservedInstanceOfferingId()`	The unique identifier of the Reserved Instance offering.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReservedInstance.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The date and time when the reservation was purchased.
`String`	`state()`	The state of the Reserved Instance.
`ReservedInstance.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Double`	`usagePrice()`	The hourly rate at which you're charged for the domain using this Reserved Instance.

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
  - reservationName
```
public final String reservationName()
```
    The customer-specified identifier to track this reservation.
    
    Returns:
    
    The customer-specified identifier to track this reservation.
  - reservedInstanceId
```
public final String reservedInstanceId()
```
    The unique identifier for the reservation.
    
    Returns:
    
    The unique identifier for the reservation.
  - billingSubscriptionId
```
public final Long billingSubscriptionId()
```
    The unique identifier of the billing subscription.
    
    Returns:
    
    The unique identifier of the billing subscription.
  - reservedInstanceOfferingId
```
public final String reservedInstanceOfferingId()
```
    The unique identifier of the Reserved Instance offering.
    
    Returns:
    
    The unique identifier of the Reserved Instance offering.
  - instanceType
```
public final OpenSearchPartitionInstanceType instanceType()
```
    The OpenSearch instance type offered by theReserved Instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return OpenSearchPartitionInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The OpenSearch instance type offered by theReserved Instance offering.
    
    See Also:
    
    OpenSearchPartitionInstanceType
  - instanceTypeAsString
```
public final String instanceTypeAsString()
```
    The OpenSearch instance type offered by theReserved Instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return OpenSearchPartitionInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The OpenSearch instance type offered by theReserved Instance offering.
    
    See Also:
    
    OpenSearchPartitionInstanceType
  - startTime
```
public final Instant startTime()
```
    The date and time when the reservation was purchased.
    
    Returns:
    
    The date and time when the reservation was purchased.
  - duration
```
public final Integer duration()
```
    The duration, in seconds, for which the OpenSearch instance is reserved.
    
    Returns:
    
    The duration, in seconds, for which the OpenSearch instance is reserved.
  - fixedPrice
```
public final Double fixedPrice()
```
    The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
    
    Returns:
    
    The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
  - usagePrice
```
public final Double usagePrice()
```
    The hourly rate at which you're charged for the domain using this Reserved Instance.
    
    Returns:
    
    The hourly rate at which you're charged for the domain using this Reserved Instance.
  - currencyCode
```
public final String currencyCode()
```
    The currency code for the offering.
    
    Returns:
    
    The currency code for the offering.
  - instanceCount
```
public final Integer instanceCount()
```
    The number of OpenSearch instances that have been reserved.
    
    Returns:
    
    The number of OpenSearch instances that have been reserved.
  - state
```
public final String state()
```
    The state of the Reserved Instance.
    
    Returns:
    
    The state of the Reserved Instance.
  - paymentOption
```
public final ReservedInstancePaymentOption paymentOption()
```
    The payment option as defined in the Reserved Instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, paymentOption will return ReservedInstancePaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().
    
    Returns:
    
    The payment option as defined in the Reserved Instance offering.
    
    See Also:
    
    ReservedInstancePaymentOption
  - paymentOptionAsString
```
public final String paymentOptionAsString()
```
    The payment option as defined in the Reserved Instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, paymentOption will return ReservedInstancePaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().
    
    Returns:
    
    The payment option as defined in the Reserved Instance offering.
    
    See Also:
    
    ReservedInstancePaymentOption
  - hasRecurringCharges
```
public final boolean hasRecurringCharges()
```
    For responses, this returns true if the service returned a value for the RecurringCharges 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.
  - recurringCharges
```
public final List<RecurringCharge> recurringCharges()
```
    The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
    
    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 hasRecurringCharges() method.
    
    Returns:
    
    The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
  - toBuilder
```
public ReservedInstance.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReservedInstance.Builder,ReservedInstance>
  - builder
```
public static ReservedInstance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReservedInstance.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 ReservedInstance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

reservationName

reservedInstanceId

billingSubscriptionId

reservedInstanceOfferingId

instanceType

instanceTypeAsString

startTime

duration

fixedPrice

usagePrice

currencyCode

instanceCount

state

paymentOption

paymentOptionAsString

hasRecurringCharges

recurringCharges

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields