Package com.commercetools.api.models.variant

Interface VariantRemoveImageAction

All Superinterfaces:
VariantUpdateAction
public interface VariantRemoveImageAction extends VariantUpdateAction

Removes a Variant's image.

Example to create an instance using the builder pattern 

     VariantRemoveImageAction variantRemoveImageAction = VariantRemoveImageAction.builder()
             .imageUrl("{imageUrl}")
             .build()

  • Field Details

  • Method Details

    • getImageUrl

      @NotNull @NotNull String getImageUrl()

      The URL of the image to remove.

      Returns:
      imageUrl

    • getStaged

      Boolean getStaged()

      If true, only the staged image is removed. If false, both the current and staged image is removed.

      Returns:
      staged

    • setImageUrl

      void setImageUrl(String imageUrl)

      The URL of the image to remove.

      Parameters:
      imageUrl - value to be set

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged image is removed. If false, both the current and staged image is removed.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantRemoveImageAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantRemoveImageActionBuilder builder()
      builder factory method for VariantRemoveImageAction
      Returns:
      builder

    • builder

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

    • withVariantRemoveImageAction

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