Package com.commercetools.api.models.product_tailoring

Interface ProductTailoringSetAssetCustomFieldAction

All Superinterfaces:
ProductTailoringUpdateAction
public interface ProductTailoringSetAssetCustomFieldAction extends ProductTailoringUpdateAction

Either variantId or sku is required to reference a ProductVariant that exists. The Asset to update must be specified using either assetId or assetKey.

Example to create an instance using the builder pattern 

     ProductTailoringSetAssetCustomFieldAction productTailoringSetAssetCustomFieldAction = ProductTailoringSetAssetCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_ASSET_CUSTOM_FIELD

      static final String SET_ASSET_CUSTOM_FIELD
      discriminator value for ProductTailoringSetAssetCustomFieldAction
      See Also:

  • Method Details

    • getVariantId

      Long getVariantId()

      The id of the tailored ProductVariant to update.

      Returns:
      variantId

    • getSku

      String getSku()

      The sku of the tailored ProductVariant to update.

      Returns:
      sku

    • 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

    • setVariantId

      void setVariantId(Long variantId)

      The id of the tailored ProductVariant to update.

      Parameters:
      variantId - value to be set

    • setSku

      void setSku(String sku)

      The sku of the tailored ProductVariant to update.

      Parameters:
      sku - value to be set

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

    • of

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

    • copyDeep

      ProductTailoringSetAssetCustomFieldAction copyDeep()
      Specified by:
      copyDeep in interface ProductTailoringUpdateAction

    • deepCopy

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

    • builder

      static ProductTailoringSetAssetCustomFieldActionBuilder builder()
      builder factory method for ProductTailoringSetAssetCustomFieldAction
      Returns:
      builder

    • builder

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

    • withProductTailoringSetAssetCustomFieldAction

      default <T> T withProductTailoringSetAssetCustomFieldAction(Function<ProductTailoringSetAssetCustomFieldAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProductTailoringSetAssetCustomFieldAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference