Package com.commercetools.api.models.product

Interface ProductAddExternalImageAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductAddExternalImageAction extends ProductUpdateAction

Either variantId or sku is required. Produces the ProductImageAdded Message.

Example to create an instance using the builder pattern 

     ProductAddExternalImageAction productAddExternalImageAction = ProductAddExternalImageAction.builder()
             .image(imageBuilder -> imageBuilder)
             .build()

  • Field Details

    • ADD_EXTERNAL_IMAGE

      static final String ADD_EXTERNAL_IMAGE
      discriminator value for ProductAddExternalImageAction
      See Also:

  • Method Details

    • getVariantId

      Long getVariantId()

      The id of the ProductVariant to update.

      Returns:
      variantId

    • getSku

      String getSku()

      The sku of the ProductVariant to update.

      Returns:
      sku

    • getImage

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

      Value to add to images.

      Returns:
      image

    • getStaged

      Boolean getStaged()

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

      Returns:
      staged

    • setVariantId

      void setVariantId(Long variantId)

      The id of the ProductVariant to update.

      Parameters:
      variantId - value to be set

    • setSku

      void setSku(String sku)

      The sku of the ProductVariant to update.

      Parameters:
      sku - value to be set

    • setImage

      void setImage(Image image)

      Value to add to images.

      Parameters:
      image - value to be set

    • setStaged

      void setStaged(Boolean staged)

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

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductAddExternalImageAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductAddExternalImageActionBuilder builder()
      builder factory method for ProductAddExternalImageAction
      Returns:
      builder

    • builder

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

    • withProductAddExternalImageAction

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