Package com.commercetools.api.models.product

Interface ProductMoveImageToPositionAction

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

Either variantId or sku is required.

Example to create an instance using the builder pattern 

     ProductMoveImageToPositionAction productMoveImageToPositionAction = ProductMoveImageToPositionAction.builder()
             .imageUrl("{imageUrl}")
             .position(0.3)
             .build()

  • Field Details

    • MOVE_IMAGE_TO_POSITION

      static final String MOVE_IMAGE_TO_POSITION
      discriminator value for ProductMoveImageToPositionAction
      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

    • getImageUrl

      @NotNull @NotNull String getImageUrl()

      The URL of the image to update.

      Returns:
      imageUrl

    • getPosition

      @NotNull @NotNull Long getPosition()

      Position in images where the image should be moved. Must be between 0 and the total number of images minus 1.

      Returns:
      position

    • 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

    • setImageUrl

      void setImageUrl(String imageUrl)

      The URL of the image to update.

      Parameters:
      imageUrl - value to be set

    • setPosition

      void setPosition(Long position)

      Position in images where the image should be moved. Must be between 0 and the total number of images minus 1.

      Parameters:
      position - 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 ProductMoveImageToPositionAction of()
      factory method
      Returns:
      instance of ProductMoveImageToPositionAction

    • of

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

    • copyDeep

      ProductMoveImageToPositionAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductMoveImageToPositionActionBuilder builder()
      builder factory method for ProductMoveImageToPositionAction
      Returns:
      builder

    • builder

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

    • withProductMoveImageToPositionAction

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