Class ReservedInstancesOffering
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReservedInstancesOffering.Builder,
ReservedInstancesOffering>
Describes a Reserved Instance offering.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone in which the Reserved Instance can be used.builder()
final CurrencyCodeValues
The currency of the Reserved Instance offering you are purchasing.final String
The currency of the Reserved Instance offering you are purchasing.final Long
duration()
The duration of the Reserved Instance, in seconds.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Float
The purchase price of the Reserved Instance.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 PricingDetails property.final boolean
For responses, this returns true if the service returned a value for the RecurringCharges property.final Tenancy
The tenancy of the instance.final String
The tenancy of the instance.final InstanceType
The instance type on which the Reserved Instance can be used.final String
The instance type on which the Reserved Instance can be used.final Boolean
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services.final OfferingClassType
Ifconvertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations.final String
Ifconvertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations.final OfferingTypeValues
The Reserved Instance offering type.final String
The Reserved Instance offering type.final List
<PricingDetail> The pricing details of the Reserved Instance offering.final RIProductDescription
The Reserved Instance product platform description.final String
The Reserved Instance product platform description.final List
<RecurringCharge> The recurring charge tag assigned to the resource.final String
The ID of the Reserved Instance offering.final Scope
scope()
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.final String
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.static Class
<? extends ReservedInstancesOffering.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 Float
The usage price of the Reserved Instance, per hour.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
availabilityZone
The Availability Zone in which the Reserved Instance can be used.
- Returns:
- The Availability Zone in which the Reserved Instance can be used.
-
duration
The duration of the Reserved Instance, in seconds.
- Returns:
- The duration of the Reserved Instance, in seconds.
-
fixedPrice
The purchase price of the Reserved Instance.
- Returns:
- The purchase price of the Reserved Instance.
-
instanceType
The instance type on which the Reserved Instance can be used.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type on which the Reserved Instance can be used.
- See Also:
-
instanceTypeAsString
The instance type on which the Reserved Instance can be used.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type on which the Reserved Instance can be used.
- See Also:
-
productDescription
The Reserved Instance product platform description.
If the service returns an enum value that is not available in the current SDK version,
productDescription
will returnRIProductDescription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductDescriptionAsString()
.- Returns:
- The Reserved Instance product platform description.
- See Also:
-
productDescriptionAsString
The Reserved Instance product platform description.
If the service returns an enum value that is not available in the current SDK version,
productDescription
will returnRIProductDescription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductDescriptionAsString()
.- Returns:
- The Reserved Instance product platform description.
- See Also:
-
reservedInstancesOfferingId
The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
- Returns:
- The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
-
usagePrice
The usage price of the Reserved Instance, per hour.
- Returns:
- The usage price of the Reserved Instance, per hour.
-
currencyCode
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is
USD
.If the service returns an enum value that is not available in the current SDK version,
currencyCode
will returnCurrencyCodeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcurrencyCodeAsString()
.- Returns:
- The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard
currency codes. At this time, the only supported currency is
USD
. - See Also:
-
currencyCodeAsString
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is
USD
.If the service returns an enum value that is not available in the current SDK version,
currencyCode
will returnCurrencyCodeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcurrencyCodeAsString()
.- Returns:
- The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard
currency codes. At this time, the only supported currency is
USD
. - See Also:
-
instanceTenancy
The tenancy of the instance.
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy of the instance.
- See Also:
-
instanceTenancyAsString
The tenancy of the instance.
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy of the instance.
- See Also:
-
marketplace
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is
true
.- Returns:
- Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon
Web Services. If it's a Reserved Instance Marketplace offering, this is
true
.
-
offeringClass
If
convertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. Ifstandard
, it is not possible to perform an exchange.If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- If
convertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. Ifstandard
, it is not possible to perform an exchange. - See Also:
-
offeringClassAsString
If
convertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. Ifstandard
, it is not possible to perform an exchange.If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- If
convertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. Ifstandard
, it is not possible to perform an exchange. - See Also:
-
offeringType
The Reserved Instance offering type.
If the service returns an enum value that is not available in the current SDK version,
offeringType
will returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- The Reserved Instance offering type.
- See Also:
-
offeringTypeAsString
The Reserved Instance offering type.
If the service returns an enum value that is not available in the current SDK version,
offeringType
will returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- The Reserved Instance offering type.
- See Also:
-
hasPricingDetails
public final boolean hasPricingDetails()For responses, this returns true if the service returned a value for the PricingDetails 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. -
pricingDetails
The pricing details of 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
hasPricingDetails()
method.- Returns:
- The pricing details of the Reserved Instance offering.
-
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 tag assigned to the resource.
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 tag assigned to the resource.
-
scope
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
- See Also:
-
scopeAsString
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
- See Also:
-
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<ReservedInstancesOffering.Builder,
ReservedInstancesOffering> - 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
-