Package software.amazon.awssdk.services.marketplacecatalog.model

Class OfferSummary

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

Summarized information about an offer.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the offer.

      Returns:
      The name of the offer.

    • productId

      public final String productId()

      The product ID of the offer.

      Returns:
      The product ID of the offer.

    • resaleAuthorizationId

      public final String resaleAuthorizationId()

      The ResaleAuthorizationId of the offer.

      Returns:
      The ResaleAuthorizationId of the offer.

    • releaseDate

      public final String releaseDate()

      The release date of the offer.

      Returns:
      The release date of the offer.

    • availabilityEndDate

      public final String availabilityEndDate()

      The availability end date of the offer.

      Returns:
      The availability end date of the offer.

    • hasBuyerAccounts

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

    • buyerAccounts

      public final List<String> buyerAccounts()

      The buyer accounts in the offer.

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

      Returns:
      The buyer accounts in the offer.

    • state

      public final OfferStateString state()

      The status of the offer.

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

      Returns:
      The status of the offer.
      See Also:

    • stateAsString

      public final String stateAsString()

      The status of the offer.

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

      Returns:
      The status of the offer.
      See Also:

    • targeting

      public final List<OfferTargetingString> targeting()

      The targeting in the offer.

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

      Returns:
      The targeting in the offer.

    • hasTargeting

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

    • targetingAsStrings

      public final List<String> targetingAsStrings()

      The targeting in the offer.

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

      Returns:
      The targeting in the offer.

    • toBuilder

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

    • builder

      public static OfferSummary.Builder builder()

    • serializableBuilderClass

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