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:

  • Method Details

    • currencyCode

      public final CurrencyCodeValues currencyCode()

      The currency in which the UpfrontPrice and HourlyPrice amounts are specified. 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 in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.
      See Also:

    • currencyCodeAsString

      public final String currencyCodeAsString()

      The currency in which the UpfrontPrice and HourlyPrice amounts are specified. 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 in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.
      See Also:

    • 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 the isEmpty() 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 return PaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().

      Returns:
      The payment option for the reservation.
      See Also:

    • 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 return PaymentOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paymentOptionAsString().

      Returns:
      The payment option for the reservation.
      See Also:

    • upfrontPrice

      public final String upfrontPrice()

      The upfront price of the reservation.

      Returns:
      The upfront price of the reservation.

    • toBuilder

      public Purchase.Builder 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 interface ToCopyableBuilder<Purchase.Builder,Purchase>
      Returns:
      a builder for type T

    • builder

      public static Purchase.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.