Class ReservedInstanceOffering
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReservedInstanceOffering.Builder,
ReservedInstanceOffering>
Details of an OpenSearch Reserved Instance offering.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The currency code for the Reserved Instance offering.final Integer
duration()
The duration, in seconds, for which the offering will reserve the OpenSearch instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Double
The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RecurringCharges property.The OpenSearch instance type offered by the Reserved Instance offering.final String
The OpenSearch instance type offered by the Reserved Instance offering.Payment option for the Reserved Instance offeringfinal String
Payment option for the Reserved Instance offeringfinal List
<RecurringCharge> The recurring charge to your account, regardless of whether you creates any domains using the offering.final String
The unique identifier of the Reserved Instance offering.static Class
<? extends ReservedInstanceOffering.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Double
The hourly rate at which you're charged for the domain using this Reserved Instance.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
reservedInstanceOfferingId
The unique identifier of the Reserved Instance offering.
- Returns:
- The unique identifier of the Reserved Instance offering.
-
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:
-
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:
-
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
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
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
The currency code for the Reserved Instance offering.
- Returns:
- The currency code for the Reserved Instance offering.
-
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:
-
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:
-
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
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
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 interfaceToCopyableBuilder<ReservedInstanceOffering.Builder,
ReservedInstanceOffering> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-