software.amazon.awssdk.services.ec2.model

Class ReservedInstancesOffering

java.lang.Object

software.amazon.awssdk.services.ec2.model.ReservedInstancesOffering

All Implemented Interfaces:

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

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

Describes a Reserved Instance offering.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReservedInstancesOffering.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZone() The Availability Zone in which the Reserved Instance can be used.
static ReservedInstancesOffering.Builder	builder()
CurrencyCodeValues	currencyCode() The currency of the Reserved Instance offering you are purchasing.
String	currencyCodeAsString() The currency of the Reserved Instance offering you are purchasing.
Long	duration() The duration of the Reserved Instance, in seconds.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Float	fixedPrice() The purchase price of the Reserved Instance.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPricingDetails() Returns true if the PricingDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasRecurringCharges() Returns true if the RecurringCharges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Tenancy	instanceTenancy() The tenancy of the instance.
String	instanceTenancyAsString() The tenancy of the instance.
InstanceType	instanceType() The instance type on which the Reserved Instance can be used.
String	instanceTypeAsString() The instance type on which the Reserved Instance can be used.
Boolean	marketplace() Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS.
OfferingClassType	offeringClass() If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations.
String	offeringClassAsString() If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations.
OfferingTypeValues	offeringType() The Reserved Instance offering type.
String	offeringTypeAsString() The Reserved Instance offering type.
List<PricingDetail>	pricingDetails() The pricing details of the Reserved Instance offering.
RIProductDescription	productDescription() The Reserved Instance product platform description.
String	productDescriptionAsString() The Reserved Instance product platform description.
List<RecurringCharge>	recurringCharges() The recurring charge tag assigned to the resource.
String	reservedInstancesOfferingId() The ID of the Reserved Instance offering.
Scope	scope() Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
String	scopeAsString() Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
List<SdkField<?>>	sdkFields()
static Class<? extends ReservedInstancesOffering.Builder>	serializableBuilderClass()
ReservedInstancesOffering.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Float	usagePrice() The usage price of the Reserved Instance, per hour.

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

availabilityZone

public String 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

public Long duration()

The duration of the Reserved Instance, in seconds.

Returns:

The duration of the Reserved Instance, in seconds.

fixedPrice

public Float fixedPrice()

The purchase price of the Reserved Instance.

Returns:

The purchase price of the Reserved Instance.

instanceType

public InstanceType 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 return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The instance type on which the Reserved Instance can be used.

See Also:

InstanceType

instanceTypeAsString

public String 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 return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The instance type on which the Reserved Instance can be used.

See Also:

InstanceType

productDescription

public RIProductDescription 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 return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

Returns:

The Reserved Instance product platform description.

See Also:

RIProductDescription

productDescriptionAsString

public String 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 return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

Returns:

The Reserved Instance product platform description.

See Also:

RIProductDescription

reservedInstancesOfferingId

public String 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

public Float usagePrice()

The usage price of the Reserved Instance, per hour.

Returns:

The usage price of the Reserved Instance, per hour.

currencyCode

public CurrencyCodeValues 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 return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeAsString().

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:

CurrencyCodeValues

currencyCodeAsString

public String 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 return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeAsString().

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:

CurrencyCodeValues

instanceTenancy

public Tenancy instanceTenancy()

The tenancy of the instance.

If the service returns an enum value that is not available in the current SDK version, instanceTenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyAsString().

Returns:

The tenancy of the instance.

See Also:

Tenancy

instanceTenancyAsString

public String instanceTenancyAsString()

The tenancy of the instance.

If the service returns an enum value that is not available in the current SDK version, instanceTenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyAsString().

Returns:

The tenancy of the instance.

See Also:

Tenancy

marketplace

public Boolean marketplace()

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. 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 AWS. If it's a Reserved Instance Marketplace offering, this is true.

offeringClass

public OfferingClassType offeringClass()

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, 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 return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().

Returns:

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.

See Also:

OfferingClassType

offeringClassAsString

public String offeringClassAsString()

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, 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 return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().

Returns:

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.

See Also:

OfferingClassType

offeringType

public OfferingTypeValues offeringType()

The Reserved Instance offering type.

If the service returns an enum value that is not available in the current SDK version, offeringType will return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().

Returns:

The Reserved Instance offering type.

See Also:

OfferingTypeValues

offeringTypeAsString

public String offeringTypeAsString()

The Reserved Instance offering type.

If the service returns an enum value that is not available in the current SDK version, offeringType will return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().

Returns:

The Reserved Instance offering type.

See Also:

OfferingTypeValues

hasPricingDetails

public boolean hasPricingDetails()

Returns true if the PricingDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

pricingDetails

public List<PricingDetail> pricingDetails()

The pricing details of the Reserved Instance offering.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPricingDetails() to see if a value was sent in this field.

Returns:

The pricing details of the Reserved Instance offering.

hasRecurringCharges

public boolean hasRecurringCharges()

Returns true if the RecurringCharges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

recurringCharges

public List<RecurringCharge> recurringCharges()

The recurring charge tag assigned to the resource.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasRecurringCharges() to see if a value was sent in this field.

Returns:

The recurring charge tag assigned to the resource.

scope

public Scope 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 return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

See Also:

Scope

scopeAsString

public String 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 return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

See Also:

Scope

toBuilder

public ReservedInstancesOffering.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReservedInstancesOffering.Builder,ReservedInstancesOffering>

builder

public static ReservedInstancesOffering.Builder builder()

serializableBuilderClass

public static Class<? extends ReservedInstancesOffering.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo