Package com.commercetools.api.models.message

Interface CustomerAddressCustomFieldAddedMessage

All Superinterfaces:
BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>
public interface CustomerAddressCustomFieldAddedMessage extends Message

Generated after adding a Custom Field to an Address of a Customer using the Set CustomField in Address update action. If a Custom Field already exists with the same name, a CustomerAddressCustomFieldChanged Message is generated instead.

Example to create an instance using the builder pattern 

     CustomerAddressCustomFieldAddedMessage customerAddressCustomFieldAddedMessage = CustomerAddressCustomFieldAddedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .name("{name}")
             .build()

  • Field Details

    • CUSTOMER_ADDRESS_CUSTOM_FIELD_ADDED

      static final String CUSTOMER_ADDRESS_CUSTOM_FIELD_ADDED
      discriminator value for CustomerAddressCustomFieldAddedMessage
      See Also:

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field that was added.

      Returns:
      name

    • getValue

      @NotNull @NotNull Object getValue()

      The added CustomFieldValue based on the FieldType.

      Returns:
      value

    • getAddressId

      String getAddressId()

      id of the Address to which the Custom Field was added.

      Returns:
      addressId

    • setName

      void setName(String name)

      Name of the Custom Field that was added.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      The added CustomFieldValue based on the FieldType.

      Parameters:
      value - value to be set

    • setAddressId

      void setAddressId(String addressId)

      id of the Address to which the Custom Field was added.

      Parameters:
      addressId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CustomerAddressCustomFieldAddedMessageBuilder builder()
      builder factory method for CustomerAddressCustomFieldAddedMessage
      Returns:
      builder

    • builder

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

    • withCustomerAddressCustomFieldAddedMessage

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