Package com.commercetools.api.models.message

Interface VariantImagesSetMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface VariantImagesSetMessagePayload extends MessagePayload

Generated after a successful Set Images update action.

Example to create an instance using the builder pattern 

     VariantImagesSetMessagePayload variantImagesSetMessagePayload = VariantImagesSetMessagePayload.builder()
             .plusImages(imagesBuilder -> imagesBuilder)
             .plusOldImages(oldImagesBuilder -> oldImagesBuilder)
             .staged(true)
             .build()

  • Field Details

    • VARIANT_IMAGES_SET

      static final String VARIANT_IMAGES_SET
      discriminator value for VariantImagesSetMessagePayload
      See Also:

  • Method Details

    • getImages

      @NotNull @Valid @NotNull @Valid List<Image> getImages()

      The images that were set on the Variant.

      Returns:
      images

    • getOldImages

      @NotNull @Valid @NotNull @Valid List<Image> getOldImages()

      The previous images of the Variant.

      Returns:
      oldImages

    • getStaged

      @NotNull @NotNull Boolean getStaged()

      Whether the update was only applied to the staged Variant.

      Returns:
      staged

    • setImages

      void setImages(Image... images)

      The images that were set on the Variant.

      Parameters:
      images - values to be set

    • setImages

      void setImages(List<Image> images)

      The images that were set on the Variant.

      Parameters:
      images - values to be set

    • setOldImages

      void setOldImages(Image... oldImages)

      The previous images of the Variant.

      Parameters:
      oldImages - values to be set

    • setOldImages

      void setOldImages(List<Image> oldImages)

      The previous images of the Variant.

      Parameters:
      oldImages - values 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 VariantImagesSetMessagePayload of()
      factory method
      Returns:
      instance of VariantImagesSetMessagePayload

    • of

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

    • copyDeep

      VariantImagesSetMessagePayload copyDeep()
      Specified by:
      copyDeep in interface MessagePayload

    • deepCopy

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

    • builder

      static VariantImagesSetMessagePayloadBuilder builder()
      builder factory method for VariantImagesSetMessagePayload
      Returns:
      builder

    • builder

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

    • withVariantImagesSetMessagePayload

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