Class DeliveryCustomFieldAddedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.DeliveryCustomFieldAddedMessageBuilder
All Implemented Interfaces:
Builder<DeliveryCustomFieldAddedMessage>

public class DeliveryCustomFieldAddedMessageBuilder extends Object implements Builder<DeliveryCustomFieldAddedMessage>
DeliveryCustomFieldAddedMessageBuilder
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()
 
  • Constructor Details

    • DeliveryCustomFieldAddedMessageBuilder

      public DeliveryCustomFieldAddedMessageBuilder()
  • Method Details

    • id

      Unique identifier of the Message. Can be used to track which Messages have been processed.

      Parameters:
      id - value to be set
      Returns:
      Builder
    • version

      public DeliveryCustomFieldAddedMessageBuilder version(Long version)

      Version of a resource. In case of Messages, this is always 1.

      Parameters:
      version - value to be set
      Returns:
      Builder
    • createdAt

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder
    • lastModifiedAt

      public DeliveryCustomFieldAddedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder
    • lastModifiedBy

      IDs and references that last modified the Message.

      Parameters:
      builder - function to build the lastModifiedBy value
      Returns:
      Builder
    • withLastModifiedBy

      IDs and references that last modified the Message.

      Parameters:
      builder - function to build the lastModifiedBy value
      Returns:
      Builder
    • lastModifiedBy

      public DeliveryCustomFieldAddedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder
    • createdBy

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder
    • withCreatedBy

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder
    • createdBy

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder
    • sequenceNumber

      public DeliveryCustomFieldAddedMessageBuilder sequenceNumber(Long sequenceNumber)

      Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

      Parameters:
      sequenceNumber - value to be set
      Returns:
      Builder
    • resource

      Reference to the resource on which the change or action was performed.

      Parameters:
      resource - value to be set
      Returns:
      Builder
    • resource

      Reference to the resource on which the change or action was performed.

      Parameters:
      builder - function to build the resource value
      Returns:
      Builder
    • resourceVersion

      public DeliveryCustomFieldAddedMessageBuilder resourceVersion(Long resourceVersion)

      Version of the resource on which the change or action was performed.

      Parameters:
      resourceVersion - value to be set
      Returns:
      Builder
    • resourceUserProvidedIdentifiers

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder
    • withResourceUserProvidedIdentifiers

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder
    • resourceUserProvidedIdentifiers

      public DeliveryCustomFieldAddedMessageBuilder resourceUserProvidedIdentifiers(@Nullable UserProvidedIdentifiers resourceUserProvidedIdentifiers)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      resourceUserProvidedIdentifiers - value to be set
      Returns:
      Builder
    • name

      Name of the Custom Field that was added.

      Parameters:
      name - value to be set
      Returns:
      Builder
    • value

      The added CustomFieldValue based on the FieldType.

      Parameters:
      value - value to be set
      Returns:
      Builder
    • deliveryId

      public DeliveryCustomFieldAddedMessageBuilder deliveryId(String deliveryId)

      Unique identifier of the Delivery.

      Parameters:
      deliveryId - value to be set
      Returns:
      Builder
    • getId

      public String getId()

      Unique identifier of the Message. Can be used to track which Messages have been processed.

      Returns:
      id
    • getVersion

      public Long getVersion()

      Version of a resource. In case of Messages, this is always 1.

      Returns:
      version
    • getCreatedAt

      public ZonedDateTime getCreatedAt()

      Date and time (UTC) the Message was generated.

      Returns:
      createdAt
    • getLastModifiedAt

      public ZonedDateTime getLastModifiedAt()

      Value of createdAt.

      Returns:
      lastModifiedAt
    • getLastModifiedBy

      @Nullable public LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the Message.

      Returns:
      lastModifiedBy
    • getCreatedBy

      @Nullable public CreatedBy getCreatedBy()

      IDs and references that created the Message.

      Returns:
      createdBy
    • getSequenceNumber

      public Long getSequenceNumber()

      Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

      Returns:
      sequenceNumber
    • getResource

      public Reference getResource()

      Reference to the resource on which the change or action was performed.

      Returns:
      resource
    • getResourceVersion

      public Long getResourceVersion()

      Version of the resource on which the change or action was performed.

      Returns:
      resourceVersion
    • getResourceUserProvidedIdentifiers

      @Nullable public UserProvidedIdentifiers getResourceUserProvidedIdentifiers()

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Returns:
      resourceUserProvidedIdentifiers
    • getName

      public String getName()

      Name of the Custom Field that was added.

      Returns:
      name
    • getValue

      public Object getValue()

      The added CustomFieldValue based on the FieldType.

      Returns:
      value
    • getDeliveryId

      public String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId
    • build

      builds DeliveryCustomFieldAddedMessage with checking for non-null required values
      Specified by:
      build in interface Builder<DeliveryCustomFieldAddedMessage>
      Returns:
      DeliveryCustomFieldAddedMessage
    • buildUnchecked

      public DeliveryCustomFieldAddedMessage buildUnchecked()
      builds DeliveryCustomFieldAddedMessage without checking for non-null required values
      Returns:
      DeliveryCustomFieldAddedMessage
    • of

      factory method for an instance of DeliveryCustomFieldAddedMessageBuilder
      Returns:
      builder
    • of

      create builder for DeliveryCustomFieldAddedMessage instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder