Package com.commercetools.api.models.message

Interface ProductPriceCustomFieldAddedMessage

All Superinterfaces:
BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>
public interface ProductPriceCustomFieldAddedMessage extends Message

Generated after adding a Custom Field to a Price using the Set Price CustomField update action.

Example to create an instance using the builder pattern 

     ProductPriceCustomFieldAddedMessage productPriceCustomFieldAddedMessage = ProductPriceCustomFieldAddedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .priceId("{priceId}")
             .variantId(0.3)
             .staged(true)
             .name("{name}")
             .build()

  • Field Details

    • PRODUCT_PRICE_CUSTOM_FIELD_ADDED

      static final String PRODUCT_PRICE_CUSTOM_FIELD_ADDED
      discriminator value for ProductPriceCustomFieldAddedMessage
      See Also:

  • Method Details

    • getPriceId

      @NotNull @NotNull String getPriceId()

      Unique identifier of the Price to which the Custom Field was added.

      Returns:
      priceId

    • getVariantId

      @NotNull @NotNull Long getVariantId()

      Unique identifier of the ProductVariant to which the Price belongs.

      Returns:
      variantId

    • getStaged

      @NotNull @NotNull Boolean getStaged()

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

      Returns:
      staged

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field that was added.

      Returns:
      name

    • getValue

      @NotNull @NotNull Object getValue()

      The added CustomFieldValue based on the FieldType.

      Returns:
      value

    • setPriceId

      void setPriceId(String priceId)

      Unique identifier of the Price to which the Custom Field was added.

      Parameters:
      priceId - value to be set

    • setVariantId

      void setVariantId(Long variantId)

      Unique identifier of the ProductVariant to which the Price belongs.

      Parameters:
      variantId - 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

    • setName

      void setName(String name)

      Name of the Custom Field that was added.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      The added CustomFieldValue based on the FieldType.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductPriceCustomFieldAddedMessageBuilder builder()
      builder factory method for ProductPriceCustomFieldAddedMessage
      Returns:
      builder

    • builder

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

    • withProductPriceCustomFieldAddedMessage

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