Package com.commercetools.api.models.message

Class DeliveryCustomFieldChangedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.DeliveryCustomFieldChangedMessageBuilder
All Implemented Interfaces:
Builder<DeliveryCustomFieldChangedMessage>
public class DeliveryCustomFieldChangedMessageBuilder extends Object implements Builder<DeliveryCustomFieldChangedMessage>
DeliveryCustomFieldChangedMessageBuilder
Example to create an instance using the builder pattern 

     DeliveryCustomFieldChangedMessage deliveryCustomFieldChangedMessage = DeliveryCustomFieldChangedMessage.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

    • DeliveryCustomFieldChangedMessageBuilder

      public DeliveryCustomFieldChangedMessageBuilder()

  • Method Details

    • id

      public DeliveryCustomFieldChangedMessageBuilder id(String 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 DeliveryCustomFieldChangedMessageBuilder version(Long version)

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

      Parameters:
      version - value to be set
      Returns:
      Builder

    • createdAt

      public DeliveryCustomFieldChangedMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public DeliveryCustomFieldChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public DeliveryCustomFieldChangedMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

      IDs and references that last modified the Message.

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

    • withLastModifiedBy

      public DeliveryCustomFieldChangedMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

      IDs and references that last modified the Message.

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

    • lastModifiedBy

      public DeliveryCustomFieldChangedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

      public DeliveryCustomFieldChangedMessageBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

      IDs and references that created the Message.

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

    • withCreatedBy

      public DeliveryCustomFieldChangedMessageBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

      IDs and references that created the Message.

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

    • createdBy

      public DeliveryCustomFieldChangedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public DeliveryCustomFieldChangedMessageBuilder 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

      public DeliveryCustomFieldChangedMessageBuilder resource(Reference resource)

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

      Parameters:
      resource - value to be set
      Returns:
      Builder

    • resource

      public DeliveryCustomFieldChangedMessageBuilder resource(Function<ReferenceBuilder,Builder<? extends Reference>> builder)

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

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

    • resourceVersion

      public DeliveryCustomFieldChangedMessageBuilder resourceVersion(Long resourceVersion)

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

      Parameters:
      resourceVersion - value to be set
      Returns:
      Builder

    • resourceUserProvidedIdentifiers

      public DeliveryCustomFieldChangedMessageBuilder resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)

      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

      public DeliveryCustomFieldChangedMessageBuilder withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)

      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 DeliveryCustomFieldChangedMessageBuilder 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

      public DeliveryCustomFieldChangedMessageBuilder name(String name)

      Name of the Custom Field that changed.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • value

      public DeliveryCustomFieldChangedMessageBuilder value(Object value)

      CustomFieldValue based on the FieldType after the Set CustomField update action.

      Parameters:
      value - value to be set
      Returns:
      Builder

    • previousValue

      public DeliveryCustomFieldChangedMessageBuilder previousValue(@Nullable Object previousValue)

      CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Delivery before, a Delivery Custom Field Added Message is generated instead.

      Parameters:
      previousValue - value to be set
      Returns:
      Builder

    • deliveryId

      public DeliveryCustomFieldChangedMessageBuilder 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 changed.

      Returns:
      name

    • getValue

      public Object getValue()

      CustomFieldValue based on the FieldType after the Set CustomField update action.

      Returns:
      value

    • getPreviousValue

      @Nullable public Object getPreviousValue()

      CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Delivery before, a Delivery Custom Field Added Message is generated instead.

      Returns:
      previousValue

    • getDeliveryId

      public String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • build

      public DeliveryCustomFieldChangedMessage build()
      builds DeliveryCustomFieldChangedMessage with checking for non-null required values
      Specified by:
      build in interface Builder<DeliveryCustomFieldChangedMessage>
      Returns:
      DeliveryCustomFieldChangedMessage

    • buildUnchecked

      public DeliveryCustomFieldChangedMessage buildUnchecked()
      builds DeliveryCustomFieldChangedMessage without checking for non-null required values
      Returns:
      DeliveryCustomFieldChangedMessage

    • of

      public static DeliveryCustomFieldChangedMessageBuilder of()
      factory method for an instance of DeliveryCustomFieldChangedMessageBuilder
      Returns:
      builder

    • of

      public static DeliveryCustomFieldChangedMessageBuilder of(DeliveryCustomFieldChangedMessage template)
      create builder for DeliveryCustomFieldChangedMessage instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder