Package com.commercetools.api.models.message

Class ParcelAddedToDeliveryMessageBuilder

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

     ParcelAddedToDeliveryMessage parcelAddedToDeliveryMessage = ParcelAddedToDeliveryMessage.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)
             .delivery(deliveryBuilder -> deliveryBuilder)
             .parcel(parcelBuilder -> parcelBuilder)
             .build()

  • Constructor Details

    • ParcelAddedToDeliveryMessageBuilder

      public ParcelAddedToDeliveryMessageBuilder()

  • Method Details

    • id

      public ParcelAddedToDeliveryMessageBuilder 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 ParcelAddedToDeliveryMessageBuilder 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 ParcelAddedToDeliveryMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ParcelAddedToDeliveryMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public ParcelAddedToDeliveryMessageBuilder 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 ParcelAddedToDeliveryMessageBuilder 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 ParcelAddedToDeliveryMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public ParcelAddedToDeliveryMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • delivery

      public ParcelAddedToDeliveryMessageBuilder delivery(Function<DeliveryBuilder,DeliveryBuilder> builder)

      Unique identifier of the Delivery.

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

    • withDelivery

      public ParcelAddedToDeliveryMessageBuilder withDelivery(Function<DeliveryBuilder,Delivery> builder)

      Unique identifier of the Delivery.

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

    • delivery

      public ParcelAddedToDeliveryMessageBuilder delivery(Delivery delivery)

      Unique identifier of the Delivery.

      Parameters:
      delivery - value to be set
      Returns:
      Builder

    • parcel

      public ParcelAddedToDeliveryMessageBuilder parcel(Function<ParcelBuilder,ParcelBuilder> builder)

      Parcel that was added to the Delivery.

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

    • withParcel

      public ParcelAddedToDeliveryMessageBuilder withParcel(Function<ParcelBuilder,Parcel> builder)

      Parcel that was added to the Delivery.

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

    • parcel

      public ParcelAddedToDeliveryMessageBuilder parcel(Parcel parcel)

      Parcel that was added to the Delivery.

      Parameters:
      parcel - value to be set
      Returns:
      Builder

    • shippingKey

      public ParcelAddedToDeliveryMessageBuilder shippingKey(@Nullable String shippingKey)

      User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

      Parameters:
      shippingKey - 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

    • getDelivery

      public Delivery getDelivery()

      Unique identifier of the Delivery.

      Returns:
      delivery

    • getParcel

      public Parcel getParcel()

      Parcel that was added to the Delivery.

      Returns:
      parcel

    • getShippingKey

      @Nullable public String getShippingKey()

      User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

      Returns:
      shippingKey

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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