Package com.commercetools.api.models.business_unit

Interface BusinessUnitSetCustomFieldAction

All Superinterfaces:
BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>
public interface BusinessUnitSetCustomFieldAction extends BusinessUnitUpdateAction

Adding a Custom Field to a Business Unit generates the BusinessUnitCustomFieldAdded Message, removing one generates the BusinessUnitCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitCustomFieldChanged Message.

Example to create an instance using the builder pattern 

     BusinessUnitSetCustomFieldAction businessUnitSetCustomFieldAction = BusinessUnitSetCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_CUSTOM_FIELD

      static final String SET_CUSTOM_FIELD
      discriminator value for BusinessUnitSetCustomFieldAction
      See Also:

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field to add, update, or remove.

      Returns:
      name

    • getValue

      Object getValue()

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

      Returns:
      value

    • setName

      void setName(String name)

      Name of the Custom Field to add, update, or remove.

      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. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static BusinessUnitSetCustomFieldActionBuilder builder()
      builder factory method for BusinessUnitSetCustomFieldAction
      Returns:
      builder

    • builder

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

    • withBusinessUnitSetCustomFieldAction

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

    • ofUnset

      static BusinessUnitSetCustomFieldAction ofUnset(String name)

    • typeReference

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