Class PurchaseOptionSummary

java.lang.Object
software.amazon.awssdk.services.marketplacediscovery.model.PurchaseOptionSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PurchaseOptionSummary.Builder,PurchaseOptionSummary>
@Generated("software.amazon.awssdk:codegen") public final class PurchaseOptionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PurchaseOptionSummary.Builder,PurchaseOptionSummary>

Summary information about a purchase option (offer or offer set) available to the buyer, including the seller, badges, and associated products.

See Also:

  • Method Details

    • purchaseOptionId

      public final String purchaseOptionId()

      The unique identifier of the purchase option.

      Returns:
      The unique identifier of the purchase option.

    • catalog

      public final String catalog()

      The name of the catalog that the purchase option belongs to.

      Returns:
      The name of the catalog that the purchase option belongs to.

    • purchaseOptionType

      public final PurchaseOptionType purchaseOptionType()

      The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.

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

      Returns:
      The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.
      See Also:

    • purchaseOptionTypeAsString

      public final String purchaseOptionTypeAsString()

      The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.

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

      Returns:
      The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.
      See Also:

    • purchaseOptionName

      public final String purchaseOptionName()

      The display name of the purchase option.

      Returns:
      The display name of the purchase option.

    • availableFromTime

      public final Instant availableFromTime()

      The date and time when the purchase option became available to the buyer.

      Returns:
      The date and time when the purchase option became available to the buyer.

    • expirationTime

      public final Instant expirationTime()

      The date and time when the purchase option expires and is no longer available for procurement.

      Returns:
      The date and time when the purchase option expires and is no longer available for procurement.

    • sellerOfRecord

      public final SellerInformation sellerOfRecord()

      The entity responsible for selling the product under this purchase option.

      Returns:
      The entity responsible for selling the product under this purchase option.

    • hasBadges

      public final boolean hasBadges()
      For responses, this returns true if the service returned a value for the Badges 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.

    • badges

      public final List<PurchaseOptionBadge> badges()

      Badges indicating special attributes of the purchase option, such as private pricing or future dated.

      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 hasBadges() method.

      Returns:
      Badges indicating special attributes of the purchase option, such as private pricing or future dated.

    • hasAssociatedEntities

      public final boolean hasAssociatedEntities()
      For responses, this returns true if the service returned a value for the AssociatedEntities 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.

    • associatedEntities

      public final List<PurchaseOptionAssociatedEntity> associatedEntities()

      The products, offers, and offer sets associated with this purchase option.

      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 hasAssociatedEntities() method.

      Returns:
      The products, offers, and offer sets associated with this purchase option.

    • toBuilder

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

    • builder

      public static PurchaseOptionSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PurchaseOptionSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.