Class Purchase
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.Purchase
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Purchase.Builder,Purchase>
@Generated("software.amazon.awssdk:codegen") public final class Purchase extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Purchase.Builder,Purchase>
Describes the result of the purchase.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Purchase.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Purchase.Builder
builder()
CurrencyCodeValues
currencyCode()
The currency in which theUpfrontPrice
andHourlyPrice
amounts are specified.String
currencyCodeAsString()
The currency in which theUpfrontPrice
andHourlyPrice
amounts are specified.Integer
duration()
The duration of the reservation's term in seconds.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasHostIdSet()
For responses, this returns true if the service returned a value for the HostIdSet property.List<String>
hostIdSet()
The IDs of the Dedicated Hosts associated with the reservation.String
hostReservationId()
The ID of the reservation.String
hourlyPrice()
The hourly price of the reservation per hour.String
instanceFamily()
The instance family on the Dedicated Host that the reservation can be associated with.PaymentOption
paymentOption()
The payment option for the reservation.String
paymentOptionAsString()
The payment option for the reservation.List<SdkField<?>>
sdkFields()
static Class<? extends Purchase.Builder>
serializableBuilderClass()
Purchase.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
upfrontPrice()
The upfront price of the reservation.-
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
-
currencyCode
public final CurrencyCodeValues currencyCode()
The currency in which the
UpfrontPrice
andHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
.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 in which the
UpfrontPrice
andHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
. - See Also:
CurrencyCodeValues
-
currencyCodeAsString
public final String currencyCodeAsString()
The currency in which the
UpfrontPrice
andHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
.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 in which the
UpfrontPrice
andHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
. - See Also:
CurrencyCodeValues
-
duration
public final Integer duration()
The duration of the reservation's term in seconds.
- Returns:
- The duration of the reservation's term in seconds.
-
hasHostIdSet
public final boolean hasHostIdSet()
For responses, this returns true if the service returned a value for the HostIdSet 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.
-
hostIdSet
public final List<String> hostIdSet()
The IDs of the Dedicated Hosts associated with the reservation.
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
hasHostIdSet()
method.- Returns:
- The IDs of the Dedicated Hosts associated with the reservation.
-
hostReservationId
public final String hostReservationId()
The ID of the reservation.
- Returns:
- The ID of the reservation.
-
hourlyPrice
public final String hourlyPrice()
The hourly price of the reservation per hour.
- Returns:
- The hourly price of the reservation per hour.
-
instanceFamily
public final String instanceFamily()
The instance family on the Dedicated Host that the reservation can be associated with.
- Returns:
- The instance family on the Dedicated Host that the reservation can be associated with.
-
paymentOption
public final PaymentOption paymentOption()
The payment option for the reservation.
If the service returns an enum value that is not available in the current SDK version,
paymentOption
will returnPaymentOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompaymentOptionAsString()
.- Returns:
- The payment option for the reservation.
- See Also:
PaymentOption
-
paymentOptionAsString
public final String paymentOptionAsString()
The payment option for the reservation.
If the service returns an enum value that is not available in the current SDK version,
paymentOption
will returnPaymentOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompaymentOptionAsString()
.- Returns:
- The payment option for the reservation.
- See Also:
PaymentOption
-
upfrontPrice
public final String upfrontPrice()
The upfront price of the reservation.
- Returns:
- The upfront price of the reservation.
-
toBuilder
public Purchase.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Purchase.Builder,Purchase>
-
builder
public static Purchase.Builder builder()
-
serializableBuilderClass
public static Class<? extends Purchase.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.
-
-