Class ReservedInstanceOffering
- java.lang.Object
-
- software.amazon.awssdk.services.opensearch.model.ReservedInstanceOffering
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReservedInstanceOffering.Builder,ReservedInstanceOffering>
@Generated("software.amazon.awssdk:codegen") public final class ReservedInstanceOffering extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReservedInstanceOffering.Builder,ReservedInstanceOffering>
Details of an OpenSearch Reserved Instance offering.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ReservedInstanceOffering.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReservedInstanceOffering.Builder
builder()
String
currencyCode()
The currency code for the Reserved 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 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 Instance offeringString
paymentOptionAsString()
Payment option for the Reserved Instance offeringList<RecurringCharge>
recurringCharges()
The recurring charge to your account, regardless of whether you creates any domains using the offering.String
reservedInstanceOfferingId()
The unique identifier of the Reserved Instance offering.List<SdkField<?>>
sdkFields()
static Class<? extends ReservedInstanceOffering.Builder>
serializableBuilderClass()
ReservedInstanceOffering.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
-
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 the Reserved Instance offering.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnOpenSearchPartitionInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- 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 returnOpenSearchPartitionInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- 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 Instance offering.
- Returns:
- The upfront fixed charge you will pay 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 Reserved Instance offering.
- Returns:
- The currency code for the Reserved Instance offering.
-
paymentOption
public final ReservedInstancePaymentOption paymentOption()
Payment option for the Reserved Instance offering
If the service returns an enum value that is not available in the current SDK version,
paymentOption
will returnReservedInstancePaymentOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompaymentOptionAsString()
.- Returns:
- Payment option for the Reserved Instance offering
- See Also:
ReservedInstancePaymentOption
-
paymentOptionAsString
public final String paymentOptionAsString()
Payment option for the Reserved Instance offering
If the service returns an enum value that is not available in the current SDK version,
paymentOption
will returnReservedInstancePaymentOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompaymentOptionAsString()
.- Returns:
- Payment option for 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 theisEmpty()
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 creates any domains using the 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 creates any domains using the offering.
-
toBuilder
public ReservedInstanceOffering.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReservedInstanceOffering.Builder,ReservedInstanceOffering>
-
builder
public static ReservedInstanceOffering.Builder builder()
-
serializableBuilderClass
public static Class<? extends ReservedInstanceOffering.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-