Package com.commercetools.api.models.message

Interface DeliveryCustomFieldAddedMessage

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

Generated after adding a Custom Field to a Delivery using the Set CustomField update action.

Example to create an instance using the builder pattern 

     DeliveryCustomFieldAddedMessage deliveryCustomFieldAddedMessage = DeliveryCustomFieldAddedMessage.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}")
             .deliveryId("{deliveryId}")
             .build()

  • Field Details

    • DELIVERY_CUSTOM_FIELD_ADDED

      static final String DELIVERY_CUSTOM_FIELD_ADDED
      discriminator value for DeliveryCustomFieldAddedMessage
      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

    • getDeliveryId

      @NotNull @NotNull String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • 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

    • setDeliveryId

      void setDeliveryId(String deliveryId)

      Unique identifier of the Delivery.

      Parameters:
      deliveryId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static DeliveryCustomFieldAddedMessageBuilder builder()
      builder factory method for DeliveryCustomFieldAddedMessage
      Returns:
      builder

    • builder

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

    • withDeliveryCustomFieldAddedMessage

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