Package com.commercetools.api.models.message

Interface ProductPublishedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface ProductPublishedMessagePayload extends MessagePayload

Generated after a successful Publish update action.

Example to create an instance using the builder pattern 

     ProductPublishedMessagePayload productPublishedMessagePayload = ProductPublishedMessagePayload.builder()
             .plusRemovedImageUrls(removedImageUrlsBuilder -> removedImageUrlsBuilder)
             .productProjection(productProjectionBuilder -> productProjectionBuilder)
             .scope(ProductPublishScope.ALL)
             .build()

  • Field Details

    • PRODUCT_PUBLISHED

      static final String PRODUCT_PUBLISHED
      discriminator value for ProductPublishedMessagePayload
      See Also:

  • Method Details

    • getRemovedImageUrls

      @NotNull @NotNull List<String> getRemovedImageUrls()

      List of image URLs which were removed during the Publish update action.

      Returns:
      removedImageUrls

    • getProductProjection

      @NotNull @Valid @NotNull @Valid ProductProjection getProductProjection()

      Current Product Projection of the Product at the time of creation.

      Returns:
      productProjection

    • getScope

      @NotNull @NotNull ProductPublishScope getScope()

      Publishing Scope that was used during the Publish update action.

      Returns:
      scope

    • setRemovedImageUrls

      void setRemovedImageUrls(String... removedImageUrls)

      List of image URLs which were removed during the Publish update action.

      Parameters:
      removedImageUrls - values to be set

    • setRemovedImageUrls

      void setRemovedImageUrls(List<String> removedImageUrls)

      List of image URLs which were removed during the Publish update action.

      Parameters:
      removedImageUrls - values to be set

    • setProductProjection

      void setProductProjection(ProductProjection productProjection)

      Current Product Projection of the Product at the time of creation.

      Parameters:
      productProjection - value to be set

    • setScope

      void setScope(ProductPublishScope scope)

      Publishing Scope that was used during the Publish update action.

      Parameters:
      scope - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductPublishedMessagePayloadBuilder builder()
      builder factory method for ProductPublishedMessagePayload
      Returns:
      builder

    • builder

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

    • withProductPublishedMessagePayload

      default <T> T withProductPublishedMessagePayload(Function<ProductPublishedMessagePayload,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<ProductPublishedMessagePayload> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference