Package com.commercetools.api.models.message

Interface ProductPriceRemovedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface ProductPriceRemovedMessagePayload extends MessagePayload

Generated after a successful Remove Price update action.

Example to create an instance using the builder pattern 

     ProductPriceRemovedMessagePayload productPriceRemovedMessagePayload = ProductPriceRemovedMessagePayload.builder()
             .variantId(0.3)
             .price(priceBuilder -> priceBuilder)
             .staged(true)
             .build()

  • Field Details

    • PRODUCT_PRICE_REMOVED

      static final String PRODUCT_PRICE_REMOVED
      discriminator value for ProductPriceRemovedMessagePayload
      See Also:

  • Method Details

    • getVariantId

      @NotNull @NotNull Long getVariantId()

      Unique identifier of the ProductVariant for which the Price was removed.

      Returns:
      variantId

    • getPrice

      @NotNull @Valid @NotNull @Valid Price getPrice()

      The Embedded Price that was removed from the ProductVariant.

      Returns:
      price

    • getStaged

      @NotNull @NotNull Boolean getStaged()

      Whether the update was only applied to the staged Product Projection.

      Returns:
      staged

    • setVariantId

      void setVariantId(Long variantId)

      Unique identifier of the ProductVariant for which the Price was removed.

      Parameters:
      variantId - value to be set

    • setPrice

      void setPrice(Price price)

      The Embedded Price that was removed from the ProductVariant.

      Parameters:
      price - value to be set

    • setStaged

      void setStaged(Boolean staged)

      Whether the update was only applied to the staged Product Projection.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductPriceRemovedMessagePayloadBuilder builder()
      builder factory method for ProductPriceRemovedMessagePayload
      Returns:
      builder

    • builder

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

    • withProductPriceRemovedMessagePayload

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