Package com.commercetools.api.models.variant

Interface VariantRemoveAssetAction

All Superinterfaces:
VariantUpdateAction
public interface VariantRemoveAssetAction extends VariantUpdateAction

Removes an asset from an existing Variant's assets. The asset to remove must be specified using either assetId or assetKey.

Example to create an instance using the builder pattern 

     VariantRemoveAssetAction variantRemoveAssetAction = VariantRemoveAssetAction.builder()
             .build()

  • Field Details

  • Method Details

    • getStaged

      Boolean getStaged()

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

      Returns:
      staged

    • getAssetId

      String getAssetId()

      The id of the Asset to remove.

      Returns:
      assetId

    • getAssetKey

      String getAssetKey()

      The key of the Asset to remove.

      Returns:
      assetKey

    • setStaged

      void setStaged(Boolean staged)

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

      Parameters:
      staged - value to be set

    • setAssetId

      void setAssetId(String assetId)

      The id of the Asset to remove.

      Parameters:
      assetId - value to be set

    • setAssetKey

      void setAssetKey(String assetKey)

      The key of the Asset to remove.

      Parameters:
      assetKey - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantRemoveAssetAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantRemoveAssetActionBuilder builder()
      builder factory method for VariantRemoveAssetAction
      Returns:
      builder

    • builder

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

    • withVariantRemoveAssetAction

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