Package com.commercetools.api.models.product_tailoring

Interface ProductTailoringSetExternalImagesAction

All Superinterfaces:
ProductTailoringUpdateAction
public interface ProductTailoringSetExternalImagesAction extends ProductTailoringUpdateAction

Either variantId or sku is required to reference a ProductVariant or Variant that exists. Produces the ProductTailoringImagesSet Message.

Example to create an instance using the builder pattern 

     ProductTailoringSetExternalImagesAction productTailoringSetExternalImagesAction = ProductTailoringSetExternalImagesAction.builder()
             .build()

  • Field Details

    • SET_IMAGES

      static final String SET_IMAGES
      discriminator value for ProductTailoringSetExternalImagesAction
      See Also:

  • Method Details

    • getVariantId

      Long getVariantId()

      The id of the tailored ProductVariant or Variant to update.

      Returns:
      variantId

    • getSku

      String getSku()

      The sku of the tailored ProductVariant or Variant to update.

      Returns:
      sku

    • getImages

      @Valid @Valid List<Image> getImages()

      Images of the tailored ProductVariant or Variant.

      Don't provide this field if you want to remove all images from the tailored ProductVariant or Variant. Set to [] (empty) if you want to hide all images of the original ProductVariant or Variant on the tailored ProductVariant or Variant.

      Returns:
      images

    • getStaged

      Boolean getStaged()

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

      Returns:
      staged

    • setVariantId

      void setVariantId(Long variantId)

      The id of the tailored ProductVariant or Variant to update.

      Parameters:
      variantId - value to be set

    • setSku

      void setSku(String sku)

      The sku of the tailored ProductVariant or Variant to update.

      Parameters:
      sku - value to be set

    • setImages

      void setImages(Image... images)

      Images of the tailored ProductVariant or Variant.

      Don't provide this field if you want to remove all images from the tailored ProductVariant or Variant. Set to [] (empty) if you want to hide all images of the original ProductVariant or Variant on the tailored ProductVariant or Variant.

      Parameters:
      images - values to be set

    • setImages

      void setImages(List<Image> images)

      Images of the tailored ProductVariant or Variant.

      Don't provide this field if you want to remove all images from the tailored ProductVariant or Variant. Set to [] (empty) if you want to hide all images of the original ProductVariant or Variant on the tailored ProductVariant or Variant.

      Parameters:
      images - values to be set

    • setStaged

      void setStaged(Boolean staged)

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

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductTailoringSetExternalImagesAction copyDeep()
      Specified by:
      copyDeep in interface ProductTailoringUpdateAction

    • deepCopy

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

    • builder

      static ProductTailoringSetExternalImagesActionBuilder builder()
      builder factory method for ProductTailoringSetExternalImagesAction
      Returns:
      builder

    • builder

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

    • withProductTailoringSetExternalImagesAction

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