software.amazon.awssdk.services.opensearch.model

Class ReservedInstanceOffering

java.lang.Object

software.amazon.awssdk.services.opensearch.model.ReservedInstanceOffering

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReservedInstanceOffering.Builder,ReservedInstanceOffering>

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

Details of a reserved OpenSearch instance offering.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReservedInstanceOffering.Builder

Method Summary

Modifier and Type	Method and Description
static ReservedInstanceOffering.Builder	builder()
String	currencyCode() The currency code for the reserved OpenSearch instance offering.
Integer	duration() The duration, in seconds, for which the offering will reserve the OpenSearch instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Double	fixedPrice() The upfront fixed charge you will pay to purchase the specific reserved OpenSearch 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.
OpenSearchPartitionInstanceType	instanceType() The OpenSearch instance type offered by the reserved instance offering.
String	instanceTypeAsString() The OpenSearch instance type offered by the reserved instance offering.
ReservedInstancePaymentOption	paymentOption() Payment option for the reserved OpenSearch instance offering
String	paymentOptionAsString() Payment option for the reserved OpenSearch instance offering
List<RecurringCharge>	recurringCharges() The charge to your account regardless of whether you are creating any domains using the instance offering.
String	reservedInstanceOfferingId() The OpenSearch reserved instance offering identifier.
List<SdkField<?>>	sdkFields()
static Class<? extends ReservedInstanceOffering.Builder>	serializableBuilderClass()
ReservedInstanceOffering.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Double	usagePrice() The rate you are charged for each hour the domain that is using the offering is running.

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

reservedInstanceOfferingId

public final String reservedInstanceOfferingId()

The OpenSearch reserved instance offering identifier.

Returns:

The OpenSearch reserved instance offering identifier.

instanceType

public final OpenSearchPartitionInstanceType instanceType()

The OpenSearch instance type offered by the reserved 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 the reserved instance offering.

See Also:

OpenSearchPartitionInstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The OpenSearch instance type offered by the reserved 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 the reserved instance offering.

See Also:

OpenSearchPartitionInstanceType

duration

public final Integer duration()

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

Returns:

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

fixedPrice

public final Double fixedPrice()

The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.

Returns:

The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.

usagePrice

public final Double usagePrice()

The rate you are charged for each hour the domain that is using the offering is running.

Returns:

The rate you are charged for each hour the domain that is using the offering is running.

currencyCode

public final String currencyCode()

The currency code for the reserved OpenSearch instance offering.

Returns:

The currency code for the reserved OpenSearch instance offering.

paymentOption

public final ReservedInstancePaymentOption paymentOption()

Payment option for the reserved OpenSearch 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:

Payment option for the reserved OpenSearch instance offering

See Also:

ReservedInstancePaymentOption

paymentOptionAsString

public final String paymentOptionAsString()

Payment option for the reserved OpenSearch 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:

Payment option for the reserved OpenSearch 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 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.

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 charge to your account regardless of whether you are creating any domains using the instance offering.

toBuilder

public ReservedInstanceOffering.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReservedInstanceOffering.Builder,ReservedInstanceOffering>

builder

public static ReservedInstanceOffering.Builder builder()

serializableBuilderClass

public static Class<? extends ReservedInstanceOffering.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