Class CatalogItem

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

Represents an item in the catalog with its complete set of attributes and metadata.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier for the catalog item.

      Returns:
      The unique identifier for the catalog item.

    • name

      public final String name()

      The display name of the catalog item.

      Returns:
      The display name of the catalog item.

    • code

      public final String code()

      The product code or SKU of the catalog item.

      Returns:
      The product code or SKU of the catalog item.

    • type

      public final String type()

      The type classification of the catalog item.

      Returns:
      The type classification of the catalog item.

    • category

      public final String category()

      The category to which the catalog item belongs.

      Returns:
      The category to which the catalog item belongs.

    • description

      public final String description()

      A detailed description of the catalog item.

      Returns:
      A detailed description of the catalog item.

    • additionalInformation

      public final String additionalInformation()

      Supplementary information about the catalog item beyond the basic description.

      Returns:
      Supplementary information about the catalog item beyond the basic description.

    • imageLink

      public final String imageLink()

      The URL link to the item's image.

      Returns:
      The URL link to the item's image.

    • link

      public final String link()

      The URL link to the item's detailed page or external resource.

      Returns:
      The URL link to the item's detailed page or external resource.

    • createdAt

      public final Instant createdAt()

      The timestamp when the catalog item was created.

      Returns:
      The timestamp when the catalog item was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the catalog item was last updated.

      Returns:
      The timestamp when the catalog item was last updated.

    • price

      public final String price()

      The price of the catalog item.

      Returns:
      The price of the catalog item.

    • hasAttributes

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

    • attributes

      public final Map<String,String> attributes()

      Additional attributes or properties associated with the catalog item stored as key-value pairs.

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

      Returns:
      Additional attributes or properties associated with the catalog item stored as key-value pairs.

    • toBuilder

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

    • builder

      public static CatalogItem.Builder builder()

    • serializableBuilderClass

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