Interface ProductSetProductPriceCustomFieldAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

public interface ProductSetProductPriceCustomFieldAction extends ProductUpdateAction
ProductSetProductPriceCustomFieldAction
Example to create an instance using the builder pattern

     ProductSetProductPriceCustomFieldAction productSetProductPriceCustomFieldAction = ProductSetProductPriceCustomFieldAction.builder()
             .priceId("{priceId}")
             .name("{name}")
             .build()
 
  • Field Details

    • SET_PRODUCT_PRICE_CUSTOM_FIELD

      static final String SET_PRODUCT_PRICE_CUSTOM_FIELD
      discriminator value for ProductSetProductPriceCustomFieldAction
      See Also:
  • Method Details

    • getPriceId

      @NotNull @NotNull String getPriceId()

      The id of the Embedded Price to update.

      Returns:
      priceId
    • getStaged

      Boolean getStaged()

      If true, only the staged Embedded Price Custom Field is updated. If false, both the current and staged Embedded Price Custom Field are updated.

      Returns:
      staged
    • 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
    • setPriceId

      void setPriceId(String priceId)

      The id of the Embedded Price to update.

      Parameters:
      priceId - value to be set
    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged Embedded Price Custom Field is updated. If false, both the current and staged Embedded Price Custom Field are updated.

      Parameters:
      staged - 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

      factory method
      Returns:
      instance of ProductSetProductPriceCustomFieldAction
    • of

      factory method to create a shallow copy ProductSetProductPriceCustomFieldAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • deepCopy

      factory method to create a deep copy of ProductSetProductPriceCustomFieldAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • builder

      builder factory method for ProductSetProductPriceCustomFieldAction
      Returns:
      builder
    • builder

      create builder for ProductSetProductPriceCustomFieldAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withProductSetProductPriceCustomFieldAction

      default <T> T withProductSetProductPriceCustomFieldAction(Function<ProductSetProductPriceCustomFieldAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value
    • ofUnset

      static ProductSetProductPriceCustomFieldAction ofUnset(String name, String priceId)
    • ofUnsetStaged

      static ProductSetProductPriceCustomFieldAction ofUnsetStaged(String name, String priceId, Boolean staged)
    • typeReference

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