Package com.commercetools.api.models.message

Interface VariantImageAddedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface VariantImageAddedMessagePayload extends MessagePayload

Generated after a successful Add External Image update action.

Example to create an instance using the builder pattern 

     VariantImageAddedMessagePayload variantImageAddedMessagePayload = VariantImageAddedMessagePayload.builder()
             .product(productBuilder -> productBuilder)
             .image(imageBuilder -> imageBuilder)
             .staged(true)
             .build()

  • Field Details

    • VARIANT_IMAGE_ADDED

      static final String VARIANT_IMAGE_ADDED
      discriminator value for VariantImageAddedMessagePayload
      See Also:

  • Method Details

    • getProduct

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

      Reference to the Product containing the Variant.

      Returns:
      product

    • getImage

      @NotNull @Valid @NotNull @Valid Image getImage()

      Image that was added.

      Returns:
      image

    • getStaged

      @NotNull @NotNull Boolean getStaged()

      Whether the update was only applied to the staged Variant.

      Returns:
      staged

    • setProduct

      void setProduct(ProductReference product)

      Reference to the Product containing the Variant.

      Parameters:
      product - value to be set

    • setImage

      void setImage(Image image)

      Image that was added.

      Parameters:
      image - value to be set

    • setStaged

      void setStaged(Boolean staged)

      Whether the update was only applied to the staged Variant.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantImageAddedMessagePayload copyDeep()
      Specified by:
      copyDeep in interface MessagePayload

    • deepCopy

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

    • builder

      static VariantImageAddedMessagePayloadBuilder builder()
      builder factory method for VariantImageAddedMessagePayload
      Returns:
      builder

    • builder

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

    • withVariantImageAddedMessagePayload

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

    • typeReference

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