Package com.commercetools.api.models.product

Interface ProductPublishAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductPublishAction extends ProductUpdateAction

Copies the product data from the Product's staged representation to its current representation and sets the published flag on the resulting ProductCatalogData to true. This makes the current representation retrievable in Product Projection endpoints and indexes it for Product Search.

Produces the ProductPublished Message.

Example to create an instance using the builder pattern 

     ProductPublishAction productPublishAction = ProductPublishAction.builder()
             .build()

  • Field Details

  • Method Details

    • getScope

      ProductPublishScope getScope()

      All or Prices

      Returns:
      scope

    • setScope

      void setScope(ProductPublishScope scope)

      All or Prices

      Parameters:
      scope - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductPublishAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductPublishActionBuilder builder()
      builder factory method for ProductPublishAction
      Returns:
      builder

    • builder

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

    • withProductPublishAction

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