Package com.commercetools.api.models.variant

Interface VariantAddAssetAction

All Superinterfaces:
VariantUpdateAction
public interface VariantAddAssetAction extends VariantUpdateAction

Adds an asset to existing variant's assets.

Example to create an instance using the builder pattern 

     VariantAddAssetAction variantAddAssetAction = VariantAddAssetAction.builder()
             .asset(assetBuilder -> assetBuilder)
             .build()

  • Field Details

  • Method Details

    • getStaged

      Boolean getStaged()

      If true, only the staged assets are updated. If false, both the current and staged assets are updated.

      Returns:
      staged

    • getAsset

      @NotNull @Valid @NotNull @Valid AssetDraft getAsset()

      Value to append.

      Returns:
      asset

    • getPosition

      Integer getPosition()

      Position in assets where the Asset should be put. When specified, the value must be between 0 and the total number of Assets minus 1.

      Returns:
      position

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged assets are updated. If false, both the current and staged assets are updated.

      Parameters:
      staged - value to be set

    • setAsset

      void setAsset(AssetDraft asset)

      Value to append.

      Parameters:
      asset - value to be set

    • setPosition

      void setPosition(Integer position)

      Position in assets where the Asset should be put. When specified, the value must be between 0 and the total number of Assets minus 1.

      Parameters:
      position - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantAddAssetAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantAddAssetActionBuilder builder()
      builder factory method for VariantAddAssetAction
      Returns:
      builder

    • builder

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

    • withVariantAddAssetAction

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