Package com.commercetools.api.models.message

Class ParcelItemsUpdatedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.ParcelItemsUpdatedMessageBuilder
All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<ParcelItemsUpdatedMessage>
public class ParcelItemsUpdatedMessageBuilder extends Object implements io.vrap.rmf.base.client.Builder<ParcelItemsUpdatedMessage>
ParcelItemsUpdatedMessageBuilder
Example to create an instance using the builder pattern 

     ParcelItemsUpdatedMessage parcelItemsUpdatedMessage = ParcelItemsUpdatedMessage.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)
             .parcelId("{parcelId}")
             .deliveryId("{deliveryId}")
             .plusItems(itemsBuilder -> itemsBuilder)
             .plusOldItems(oldItemsBuilder -> oldItemsBuilder)
             .build()

  • Constructor Details

    • ParcelItemsUpdatedMessageBuilder

      public ParcelItemsUpdatedMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ParcelItemsUpdatedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      Value of createdBy.

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

    • withLastModifiedBy

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

      Value of createdBy.

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

    • lastModifiedBy

      public ParcelItemsUpdatedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      Value of createdBy.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      Present on resources created after 1 February 2019 except for events not tracked.

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

    • withCreatedBy

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

      Present on resources created after 1 February 2019 except for events not tracked.

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

    • createdBy

      public ParcelItemsUpdatedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      Present on resources created after 1 February 2019 except for events not tracked.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public ParcelItemsUpdatedMessageBuilder 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 ParcelItemsUpdatedMessageBuilder 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 ParcelItemsUpdatedMessageBuilder resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.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 ParcelItemsUpdatedMessageBuilder 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 ParcelItemsUpdatedMessageBuilder 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 ParcelItemsUpdatedMessageBuilder 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 ParcelItemsUpdatedMessageBuilder 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

    • parcelId

      public ParcelItemsUpdatedMessageBuilder parcelId(String parcelId)

      Unique identifier of the Parcel.

      Parameters:
      parcelId - value to be set
      Returns:
      Builder

    • deliveryId

      public ParcelItemsUpdatedMessageBuilder deliveryId(String deliveryId)

      Unique identifier of the Delivery.

      Parameters:
      deliveryId - value to be set
      Returns:
      Builder

    • items

      public ParcelItemsUpdatedMessageBuilder items(DeliveryItem... items)

      Delivery Items after the Set Parcel Items update action.

      Parameters:
      items - value to be set
      Returns:
      Builder

    • items

      public ParcelItemsUpdatedMessageBuilder items(List<DeliveryItem> items)

      Delivery Items after the Set Parcel Items update action.

      Parameters:
      items - value to be set
      Returns:
      Builder

    • plusItems

      public ParcelItemsUpdatedMessageBuilder plusItems(DeliveryItem... items)

      Delivery Items after the Set Parcel Items update action.

      Parameters:
      items - value to be set
      Returns:
      Builder

    • plusItems

      public ParcelItemsUpdatedMessageBuilder plusItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)

      Delivery Items after the Set Parcel Items update action.

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

    • withItems

      public ParcelItemsUpdatedMessageBuilder withItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)

      Delivery Items after the Set Parcel Items update action.

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

    • addItems

      public ParcelItemsUpdatedMessageBuilder addItems(Function<DeliveryItemBuilder,DeliveryItem> builder)

      Delivery Items after the Set Parcel Items update action.

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

    • setItems

      public ParcelItemsUpdatedMessageBuilder setItems(Function<DeliveryItemBuilder,DeliveryItem> builder)

      Delivery Items after the Set Parcel Items update action.

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

    • oldItems

      public ParcelItemsUpdatedMessageBuilder oldItems(DeliveryItem... oldItems)

      Delivery Items before the Set Parcel Items update action.

      Parameters:
      oldItems - value to be set
      Returns:
      Builder

    • oldItems

      public ParcelItemsUpdatedMessageBuilder oldItems(List<DeliveryItem> oldItems)

      Delivery Items before the Set Parcel Items update action.

      Parameters:
      oldItems - value to be set
      Returns:
      Builder

    • plusOldItems

      public ParcelItemsUpdatedMessageBuilder plusOldItems(DeliveryItem... oldItems)

      Delivery Items before the Set Parcel Items update action.

      Parameters:
      oldItems - value to be set
      Returns:
      Builder

    • plusOldItems

      public ParcelItemsUpdatedMessageBuilder plusOldItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)

      Delivery Items before the Set Parcel Items update action.

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

    • withOldItems

      public ParcelItemsUpdatedMessageBuilder withOldItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)

      Delivery Items before the Set Parcel Items update action.

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

    • addOldItems

      public ParcelItemsUpdatedMessageBuilder addOldItems(Function<DeliveryItemBuilder,DeliveryItem> builder)

      Delivery Items before the Set Parcel Items update action.

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

    • setOldItems

      public ParcelItemsUpdatedMessageBuilder setOldItems(Function<DeliveryItemBuilder,DeliveryItem> builder)

      Delivery Items before the Set Parcel Items update action.

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

    • shippingKey

      public ParcelItemsUpdatedMessageBuilder 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()

      Value of createdBy.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Nullable public CreatedBy getCreatedBy()

      Present on resources created after 1 February 2019 except for events not tracked.

      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

    • getParcelId

      public String getParcelId()

      Unique identifier of the Parcel.

      Returns:
      parcelId

    • getDeliveryId

      public String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • getItems

      public List<DeliveryItem> getItems()

      Delivery Items after the Set Parcel Items update action.

      Returns:
      items

    • getOldItems

      public List<DeliveryItem> getOldItems()

      Delivery Items before the Set Parcel Items update action.

      Returns:
      oldItems

    • getShippingKey

      @Nullable public String getShippingKey()

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

      Returns:
      shippingKey

    • build

      public ParcelItemsUpdatedMessage build()
      builds ParcelItemsUpdatedMessage with checking for non-null required values
      Specified by:
      build in interface io.vrap.rmf.base.client.Builder<ParcelItemsUpdatedMessage>
      Returns:
      ParcelItemsUpdatedMessage

    • buildUnchecked

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

    • of

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

    • of

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