Package com.commercetools.api.models.message

Class ParcelTrackingDataUpdatedMessageBuilder

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

     ParcelTrackingDataUpdatedMessage parcelTrackingDataUpdatedMessage = ParcelTrackingDataUpdatedMessage.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)
             .deliveryId("{deliveryId}")
             .parcelId("{parcelId}")
             .build()

  • Constructor Details

    • ParcelTrackingDataUpdatedMessageBuilder

      public ParcelTrackingDataUpdatedMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ParcelTrackingDataUpdatedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      Value of createdBy.

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

    • withLastModifiedBy

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

      Value of createdBy.

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

    • lastModifiedBy

      public ParcelTrackingDataUpdatedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      Value of createdBy.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

    • deliveryId

      public ParcelTrackingDataUpdatedMessageBuilder deliveryId(String deliveryId)

      Unique identifier of the Delivery.

      Parameters:
      deliveryId - value to be set
      Returns:
      Builder

    • parcelId

      public ParcelTrackingDataUpdatedMessageBuilder parcelId(String parcelId)

      Unique identifier of the Parcel.

      Parameters:
      parcelId - value to be set
      Returns:
      Builder

    • trackingData

      public ParcelTrackingDataUpdatedMessageBuilder trackingData(Function<TrackingDataBuilder,TrackingDataBuilder> builder)

      The Tracking Data that was added to the Parcel.

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

    • withTrackingData

      public ParcelTrackingDataUpdatedMessageBuilder withTrackingData(Function<TrackingDataBuilder,TrackingData> builder)

      The Tracking Data that was added to the Parcel.

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

    • trackingData

      public ParcelTrackingDataUpdatedMessageBuilder trackingData(@Nullable TrackingData trackingData)

      The Tracking Data that was added to the Parcel.

      Parameters:
      trackingData - value to be set
      Returns:
      Builder

    • shippingKey

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

    • getDeliveryId

      public String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • getParcelId

      public String getParcelId()

      Unique identifier of the Parcel.

      Returns:
      parcelId

    • getTrackingData

      @Nullable public TrackingData getTrackingData()

      The Tracking Data that was added to the Parcel.

      Returns:
      trackingData

    • getShippingKey

      @Nullable public String getShippingKey()

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

      Returns:
      shippingKey

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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