Package com.commercetools.api.models.variant

Interface VariantMoveImageToPositionAction

All Superinterfaces:
VariantUpdateAction
public interface VariantMoveImageToPositionAction extends VariantUpdateAction

Moves a Variant's image to a new position.

Example to create an instance using the builder pattern 

     VariantMoveImageToPositionAction variantMoveImageToPositionAction = VariantMoveImageToPositionAction.builder()
             .imageUrl("{imageUrl}")
             .position(0.3)
             .build()

  • Field Details

    • MOVE_IMAGE_TO_POSITION

      static final String MOVE_IMAGE_TO_POSITION
      discriminator value for VariantMoveImageToPositionAction
      See Also:

  • Method Details

    • 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

    • 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 VariantMoveImageToPositionAction of()
      factory method
      Returns:
      instance of VariantMoveImageToPositionAction

    • of

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

    • copyDeep

      VariantMoveImageToPositionAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantMoveImageToPositionActionBuilder builder()
      builder factory method for VariantMoveImageToPositionAction
      Returns:
      builder

    • builder

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

    • withVariantMoveImageToPositionAction

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