Package com.commercetools.api.models.message

Interface ProductTailoringCreatedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface ProductTailoringCreatedMessagePayload extends MessagePayload

Generated after a successful Create Product Tailoring or Create Product Tailoring in Store request.

Example to create an instance using the builder pattern 

     ProductTailoringCreatedMessagePayload productTailoringCreatedMessagePayload = ProductTailoringCreatedMessagePayload.builder()
             .store(storeBuilder -> storeBuilder)
             .product(productBuilder -> productBuilder)
             .published(true)
             .build()

  • Field Details

    • PRODUCT_TAILORING_CREATED

      static final String PRODUCT_TAILORING_CREATED
      discriminator value for ProductTailoringCreatedMessagePayload
      See Also:

  • Method Details

    • getKey

      String getKey()

      User-defined unique identifier of the Product Tailoring.

      Returns:
      key

    • getStore

      @NotNull @Valid @NotNull @Valid StoreKeyReference getStore()

      The Store to which the Product Tailoring belongs.

      Returns:
      store

    • getProductKey

      String getProductKey()

      User-defined unique identifier of the Product this Product Tailoring belongs to.

      Returns:
      productKey

    • getProduct

      @NotNull @Valid @NotNull @Valid ProductReference getProduct()

      Reference to the Product the Product Tailoring belongs to.

      Returns:
      product

    • getDescription

      @Valid @Valid LocalizedString getDescription()

      The description of the Product Tailoring at the time of creation.

      Returns:
      description

    • getName

      @Valid @Valid LocalizedString getName()

      The name of the Product Tailoring at the time of creation.

      Returns:
      name

    • getSlug

      @Valid @Valid LocalizedString getSlug()

      The slug of the Product Tailoring at the time of creation.

      Returns:
      slug

    • getMetaTitle

      @Valid @Valid LocalizedString getMetaTitle()

      The metaTitle of the Product Tailoring at the time of creation.

      Returns:
      metaTitle

    • getMetaDescription

      @Valid @Valid LocalizedString getMetaDescription()

      The metaDescription of the Product Tailoring at the time of creation.

      Returns:
      metaDescription

    • getMetaKeywords

      @Valid @Valid LocalizedString getMetaKeywords()

      The metaKeywords of the Product Tailoring at the time of creation.

      Returns:
      metaKeywords

    • getVariants

      @Valid @Valid List<ProductVariantTailoring> getVariants()

      The variants of the Product Tailoring at the time of creation.

      Returns:
      variants

    • getAttributes

      @Valid @Valid List<ProductTailoringAttribute> getAttributes()

      Attributes of the tailored Product. If available, these Attributes are selectively merged into the attributes of the corresponding Product. If the Product contains an Attribute with the same name, then its value is overwritten. Otherwise, the Attribute and its value are added to the Product.

      Returns:
      attributes

    • getPublished

      @NotNull @NotNull Boolean getPublished()

      true if the ProductTailoring is published.

      Returns:
      published

    • setKey

      void setKey(String key)

      User-defined unique identifier of the Product Tailoring.

      Parameters:
      key - value to be set

    • setStore

      void setStore(StoreKeyReference store)

      The Store to which the Product Tailoring belongs.

      Parameters:
      store - value to be set

    • setProductKey

      void setProductKey(String productKey)

      User-defined unique identifier of the Product this Product Tailoring belongs to.

      Parameters:
      productKey - value to be set

    • setProduct

      void setProduct(ProductReference product)

      Reference to the Product the Product Tailoring belongs to.

      Parameters:
      product - value to be set

    • setDescription

      void setDescription(LocalizedString description)

      The description of the Product Tailoring at the time of creation.

      Parameters:
      description - value to be set

    • setName

      void setName(LocalizedString name)

      The name of the Product Tailoring at the time of creation.

      Parameters:
      name - value to be set

    • setSlug

      void setSlug(LocalizedString slug)

      The slug of the Product Tailoring at the time of creation.

      Parameters:
      slug - value to be set

    • setMetaTitle

      void setMetaTitle(LocalizedString metaTitle)

      The metaTitle of the Product Tailoring at the time of creation.

      Parameters:
      metaTitle - value to be set

    • setMetaDescription

      void setMetaDescription(LocalizedString metaDescription)

      The metaDescription of the Product Tailoring at the time of creation.

      Parameters:
      metaDescription - value to be set

    • setMetaKeywords

      void setMetaKeywords(LocalizedString metaKeywords)

      The metaKeywords of the Product Tailoring at the time of creation.

      Parameters:
      metaKeywords - value to be set

    • setVariants

      void setVariants(ProductVariantTailoring... variants)

      The variants of the Product Tailoring at the time of creation.

      Parameters:
      variants - values to be set

    • setVariants

      void setVariants(List<ProductVariantTailoring> variants)

      The variants of the Product Tailoring at the time of creation.

      Parameters:
      variants - values to be set

    • setAttributes

      void setAttributes(ProductTailoringAttribute... attributes)

      Attributes of the tailored Product. If available, these Attributes are selectively merged into the attributes of the corresponding Product. If the Product contains an Attribute with the same name, then its value is overwritten. Otherwise, the Attribute and its value are added to the Product.

      Parameters:
      attributes - values to be set

    • setAttributes

      void setAttributes(List<ProductTailoringAttribute> attributes)

      Attributes of the tailored Product. If available, these Attributes are selectively merged into the attributes of the corresponding Product. If the Product contains an Attribute with the same name, then its value is overwritten. Otherwise, the Attribute and its value are added to the Product.

      Parameters:
      attributes - values to be set

    • setPublished

      void setPublished(Boolean published)

      true if the ProductTailoring is published.

      Parameters:
      published - value to be set

    • of

      static ProductTailoringCreatedMessagePayload of()
      factory method
      Returns:
      instance of ProductTailoringCreatedMessagePayload

    • of

      static ProductTailoringCreatedMessagePayload of(ProductTailoringCreatedMessagePayload template)
      factory method to create a shallow copy ProductTailoringCreatedMessagePayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ProductTailoringCreatedMessagePayload copyDeep()
      Specified by:
      copyDeep in interface MessagePayload

    • deepCopy

      @Nullable static ProductTailoringCreatedMessagePayload deepCopy(@Nullable ProductTailoringCreatedMessagePayload template)
      factory method to create a deep copy of ProductTailoringCreatedMessagePayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProductTailoringCreatedMessagePayloadBuilder builder()
      builder factory method for ProductTailoringCreatedMessagePayload
      Returns:
      builder

    • builder

      static ProductTailoringCreatedMessagePayloadBuilder builder(ProductTailoringCreatedMessagePayload template)
      create builder for ProductTailoringCreatedMessagePayload instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProductTailoringCreatedMessagePayload

      default <T> T withProductTailoringCreatedMessagePayload(Function<ProductTailoringCreatedMessagePayload,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProductTailoringCreatedMessagePayload> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference