Package com.commercetools.api.models.variant

Interface VariantSetAssetCustomFieldAction

All Superinterfaces:
VariantUpdateAction
public interface VariantSetAssetCustomFieldAction extends VariantUpdateAction

Sets or removes a Custom Field on an existing Asset of a Variant. The Asset to update must be specified using either assetId or assetKey.

Example to create an instance using the builder pattern 

     VariantSetAssetCustomFieldAction variantSetAssetCustomFieldAction = VariantSetAssetCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_ASSET_CUSTOM_FIELD

      static final String SET_ASSET_CUSTOM_FIELD
      discriminator value for VariantSetAssetCustomFieldAction
      See Also:

  • Method Details

    • getStaged

      Boolean getStaged()

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

      Returns:
      staged

    • getAssetId

      String getAssetId()

      The id of the Asset to update.

      Returns:
      assetId

    • getAssetKey

      String getAssetKey()

      The key of the Asset to update.

      Returns:
      assetKey

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      Object getValue()

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Returns:
      value

    • setStaged

      void setStaged(Boolean staged)

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

      Parameters:
      staged - value to be set

    • setAssetId

      void setAssetId(String assetId)

      The id of the Asset to update.

      Parameters:
      assetId - value to be set

    • setAssetKey

      void setAssetKey(String assetKey)

      The key of the Asset to update.

      Parameters:
      assetKey - value to be set

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantSetAssetCustomFieldAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantSetAssetCustomFieldActionBuilder builder()
      builder factory method for VariantSetAssetCustomFieldAction
      Returns:
      builder

    • builder

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

    • withVariantSetAssetCustomFieldAction

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