Class ListingSummary

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

Summary information about a listing returned by search operations, including the listing name, description, badges, categories, pricing models, reviews, and associated products.

See Also:

  • Method Details

    • listingId

      public final String listingId()

      The unique identifier of the listing.

      Returns:
      The unique identifier of the listing.

    • listingName

      public final String listingName()

      The human-readable display name of the listing.

      Returns:
      The human-readable display name of the listing.

    • publisher

      public final SellerInformation publisher()

      The entity who created and published the listing.

      Returns:
      The entity who created and published the listing.

    • catalog

      public final String catalog()

      The name of the catalog that the listing belongs to.

      Returns:
      The name of the catalog that the listing belongs to.

    • shortDescription

      public final String shortDescription()

      A 1–3 sentence summary describing the key aspects of the listing.

      Returns:
      A 1–3 sentence summary describing the key aspects of the listing.

    • logoThumbnailUrl

      public final String logoThumbnailUrl()

      The URL of the logo thumbnail image for the listing.

      Returns:
      The URL of the logo thumbnail image for the listing.

    • hasCategories

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

    • categories

      public final List<Category> categories()

      The categories used to classify this listing into logical groups.

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

      Returns:
      The categories used to classify this listing into logical groups.

    • hasFulfillmentOptionSummaries

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

    • fulfillmentOptionSummaries

      public final List<FulfillmentOptionSummary> fulfillmentOptionSummaries()

      A summary of fulfillment options available for the listing.

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

      Returns:
      A summary of fulfillment options available for the listing.

    • 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<ListingBadge> badges()

      Badges indicating special attributes of the listing.

      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 listing.

    • reviewSummary

      public final ReviewSummary reviewSummary()

      A summary of customer reviews for the listing.

      Returns:
      A summary of customer reviews for the listing.

    • hasPricingModels

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

    • pricingModels

      public final List<PricingModel> pricingModels()

      The pricing models for offers associated with this listing.

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

      Returns:
      The pricing models for offers associated with this listing.

    • hasPricingUnits

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

    • pricingUnits

      public final List<PricingUnit> pricingUnits()

      The pricing units that define the billing dimensions for offers associated with this listing.

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

      Returns:
      The pricing units that define the billing dimensions for offers associated with this listing.

    • 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<ListingSummaryAssociatedEntity> associatedEntities()

      The products associated with this listing.

      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 associated with this listing.

    • toBuilder

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

    • builder

      public static ListingSummary.Builder builder()

    • serializableBuilderClass

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