Package com.commercetools.api.models.variant

Interface VariantSetImagesAction

All Superinterfaces:
VariantUpdateAction
public interface VariantSetImagesAction extends VariantUpdateAction

Sets the images of the Variant. Existing images will be replaced with the new ones. Generates the VariantImagesSet Message.

Example to create an instance using the builder pattern 

     VariantSetImagesAction variantSetImagesAction = VariantSetImagesAction.builder()
             .plusImages(imagesBuilder -> imagesBuilder)
             .build()

  • Field Details

  • Method Details

    • getImages

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

      Images to set for the Variant.

      Returns:
      images

    • getStaged

      Boolean getStaged()

      If true, only the staged images are updated. If false, both the current and staged images are updated.

      Returns:
      staged

    • setImages

      void setImages(Image... images)

      Images to set for the Variant.

      Parameters:
      images - values to be set

    • setImages

      void setImages(List<Image> images)

      Images to set for the Variant.

      Parameters:
      images - values to be set

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged images are updated. If false, both the current and staged images are updated.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantSetImagesAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantSetImagesActionBuilder builder()
      builder factory method for VariantSetImagesAction
      Returns:
      builder

    • builder

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

    • withVariantSetImagesAction

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