Package com.commercetools.api.models.business_unit

Interface BusinessUnitSetAddressCustomFieldAction

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

Adding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.

Example to create an instance using the builder pattern 

     BusinessUnitSetAddressCustomFieldAction businessUnitSetAddressCustomFieldAction = BusinessUnitSetAddressCustomFieldAction.builder()
             .addressId("{addressId}")
             .name("{name}")
             .build()

  • Field Details

    • SET_ADDRESS_CUSTOM_FIELD

      static final String SET_ADDRESS_CUSTOM_FIELD
      discriminator value for BusinessUnitSetAddressCustomFieldAction
      See Also:

  • Method Details

    • getAddressId

      @NotNull @NotNull String getAddressId()

      ID of the address to be extended.

      Returns:
      addressId

    • 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. 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

    • setAddressId

      void setAddressId(String addressId)

      ID of the address to be extended.

      Parameters:
      addressId - 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. 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 BusinessUnitSetAddressCustomFieldAction of()
      factory method
      Returns:
      instance of BusinessUnitSetAddressCustomFieldAction

    • of

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

    • deepCopy

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

    • builder

      static BusinessUnitSetAddressCustomFieldActionBuilder builder()
      builder factory method for BusinessUnitSetAddressCustomFieldAction
      Returns:
      builder

    • builder

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

    • withBusinessUnitSetAddressCustomFieldAction

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

    • ofUnset

      static BusinessUnitSetAddressCustomFieldAction ofUnset(String name)

    • typeReference

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