ReservedElasticsearchInstance (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.elasticsearch.model.ReservedElasticsearchInstance

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

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

Details of a reserved Elasticsearch instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReservedElasticsearchInstance.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReservedElasticsearchInstance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReservedElasticsearchInstance.Builder`	`builder()`
`String`	`currencyCode()` The currency code for the reserved Elasticsearch instance offering.
`Integer`	`duration()` The duration, in seconds, for which the Elasticsearch instance is reserved.
`Integer`	`elasticsearchInstanceCount()` The number of Elasticsearch instances that have been reserved.
`ESPartitionInstanceType`	`elasticsearchInstanceType()` The Elasticsearch instance type offered by the reserved instance offering.
`String`	`elasticsearchInstanceTypeAsString()` The Elasticsearch instance type offered by the reserved instance offering.
`boolean`	`equals(Object obj)`
`Double`	`fixedPrice()` The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`ReservedElasticsearchInstancePaymentOption`	`paymentOption()` The payment option as defined in the reserved Elasticsearch instance offering.
`String`	`paymentOptionAsString()` The payment option as defined in the reserved Elasticsearch instance offering.
`List<RecurringCharge>`	`recurringCharges()` The charge to your account regardless of whether you are creating any domains using the instance offering.
`String`	`reservationName()` The customer-specified identifier to track this reservation.
`String`	`reservedElasticsearchInstanceId()` The unique identifier for the reservation.
`String`	`reservedElasticsearchInstanceOfferingId()` The offering identifier.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReservedElasticsearchInstance.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The time the reservation started.
`String`	`state()` The state of the reserved Elasticsearch instance.
`ReservedElasticsearchInstance.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - reservationName
```
public String reservationName()
```
    The customer-specified identifier to track this reservation.
    
    Returns:
    
    The customer-specified identifier to track this reservation.
  - reservedElasticsearchInstanceId
```
public String reservedElasticsearchInstanceId()
```
    The unique identifier for the reservation.
    
    Returns:
    
    The unique identifier for the reservation.
  - reservedElasticsearchInstanceOfferingId
```
public String reservedElasticsearchInstanceOfferingId()
```
    The offering identifier.
    
    Returns:
    
    The offering identifier.
  - elasticsearchInstanceType
```
public ESPartitionInstanceType elasticsearchInstanceType()
```
    The Elasticsearch instance type offered by the reserved instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, elasticsearchInstanceType will return ESPartitionInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from elasticsearchInstanceTypeAsString().
    
    Returns:
    
    The Elasticsearch instance type offered by the reserved instance offering.
    
    See Also:
    
    ESPartitionInstanceType
  - elasticsearchInstanceTypeAsString
```
public String elasticsearchInstanceTypeAsString()
```
    The Elasticsearch instance type offered by the reserved instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, elasticsearchInstanceType will return ESPartitionInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from elasticsearchInstanceTypeAsString().
    
    Returns:
    
    The Elasticsearch instance type offered by the reserved instance offering.
    
    See Also:
    
    ESPartitionInstanceType
  - startTime
```
public Instant startTime()
```
    The time the reservation started.
    
    Returns:
    
    The time the reservation started.
  - duration
```
public Integer duration()
```
    The duration, in seconds, for which the Elasticsearch instance is reserved.
    
    Returns:
    
    The duration, in seconds, for which the Elasticsearch instance is reserved.
  - fixedPrice
```
public Double fixedPrice()
```
    The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
    
    Returns:
    
    The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
  - usagePrice
```
public Double usagePrice()
```
    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.
  - currencyCode
```
public String currencyCode()
```
    The currency code for the reserved Elasticsearch instance offering.
    
    Returns:
    
    The currency code for the reserved Elasticsearch instance offering.
  - elasticsearchInstanceCount
```
public Integer elasticsearchInstanceCount()
```
    The number of Elasticsearch instances that have been reserved.
    
    Returns:
    
    The number of Elasticsearch instances that have been reserved.
  - state
```
public String state()
```
    The state of the reserved Elasticsearch instance.
    
    Returns:
    
    The state of the reserved Elasticsearch instance.
  - paymentOption
```
public ReservedElasticsearchInstancePaymentOption paymentOption()
```
    The payment option as defined in the reserved Elasticsearch instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, paymentOption will return ReservedElasticsearchInstancePaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().
    
    Returns:
    
    The payment option as defined in the reserved Elasticsearch instance offering.
    
    See Also:
    
    ReservedElasticsearchInstancePaymentOption
  - paymentOptionAsString
```
public String paymentOptionAsString()
```
    The payment option as defined in the reserved Elasticsearch instance offering.
    
    If the service returns an enum value that is not available in the current SDK version, paymentOption will return ReservedElasticsearchInstancePaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().
    
    Returns:
    
    The payment option as defined in the reserved Elasticsearch instance offering.
    
    See Also:
    
    ReservedElasticsearchInstancePaymentOption
  - recurringCharges
```
public List<RecurringCharge> recurringCharges()
```
    The charge to your account regardless of whether you are creating any domains using the instance offering.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The charge to your account regardless of whether you are creating any domains using the instance offering.
  - toBuilder
```
public ReservedElasticsearchInstance.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReservedElasticsearchInstance.Builder,ReservedElasticsearchInstance>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ReservedElasticsearchInstance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReservedElasticsearchInstance.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ReservedElasticsearchInstance

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

reservedElasticsearchInstanceId

reservedElasticsearchInstanceOfferingId

elasticsearchInstanceType

elasticsearchInstanceTypeAsString

startTime

duration

fixedPrice

usagePrice

currencyCode

elasticsearchInstanceCount

state

paymentOption

paymentOptionAsString

recurringCharges

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields