Class ParcelTrackingDataUpdatedMessageBuilder
- All Implemented Interfaces:
Builder<ParcelTrackingDataUpdatedMessage>
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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds ParcelTrackingDataUpdatedMessage with checking for non-null required valuesbuilds ParcelTrackingDataUpdatedMessage without checking for non-null required valuescreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Message was generated.IDs and references that created the Message.createdBy
(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Message.deliveryId
(String deliveryId) Unique identifier of the Delivery.Date and time (UTC) the Message was generated.IDs and references that created the Message.Unique identifier of the Delivery.getId()
Unique identifier of the Message.Value ofcreatedAt
.IDs and references that last modified the Message.Unique identifier of the Parcel.Reference to the resource on which the change or action was performed.User-provided identifiers of the resource, such askey
orexternalId
.Version of the resource on which the change or action was performed.Message number in relation to other Messages for a given resource.User-defined unique identifier of the Shipping Method in a Cart withMultiple
ShippingMode.The Tracking Data that was added to the Parcel.Version of a resource.Unique identifier of the Message.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) IDs and references that last modified the Message.IDs and references that last modified the Message.of()
factory method for an instance of ParcelTrackingDataUpdatedMessageBuilderof
(ParcelTrackingDataUpdatedMessage template) create builder for ParcelTrackingDataUpdatedMessage instanceUnique identifier of the Parcel.Reference to the resource on which the change or action was performed.resource
(Function<ReferenceBuilder, Builder<? extends Reference>> builder) Reference to the resource on which the change or action was performed.resourceUserProvidedIdentifiers
(UserProvidedIdentifiers resourceUserProvidedIdentifiers) User-provided identifiers of the resource, such askey
orexternalId
.resourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiersBuilder> builder) User-provided identifiers of the resource, such askey
orexternalId
.resourceVersion
(Long resourceVersion) Version of the resource on which the change or action was performed.sequenceNumber
(Long sequenceNumber) Message number in relation to other Messages for a given resource.shippingKey
(String shippingKey) User-defined unique identifier of the Shipping Method in a Cart withMultiple
ShippingMode.trackingData
(TrackingData trackingData) The Tracking Data that was added to the Parcel.The Tracking Data that was added to the Parcel.Version of a resource.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) IDs and references that created the Message.IDs and references that last modified the Message.withResourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askey
orexternalId
.The Tracking Data that was added to the Parcel.
-
Constructor Details
-
ParcelTrackingDataUpdatedMessageBuilder
public ParcelTrackingDataUpdatedMessageBuilder()
-
-
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
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
Value of
createdAt
.- Parameters:
lastModifiedAt
- value to be set- Returns:
- Builder
-
lastModifiedBy
public ParcelTrackingDataUpdatedMessageBuilder 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 ParcelTrackingDataUpdatedMessageBuilder 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 ParcelTrackingDataUpdatedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy) IDs and references that last modified the Message.
- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
public ParcelTrackingDataUpdatedMessageBuilder createdBy(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Message.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
withCreatedBy
public ParcelTrackingDataUpdatedMessageBuilder withCreatedBy(Function<CreatedByBuilder, CreatedBy> builder) 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
Message number in relation to other Messages for a given resource. The
sequenceNumber
of the next Message for the resource is the successor of thesequenceNumber
of the current Message. Meaning, thesequenceNumber
of the next Message equals thesequenceNumber
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
public ParcelTrackingDataUpdatedMessageBuilder 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
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
orexternalId
. 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
orexternalId
. 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
orexternalId
. Only present if the resource has such identifiers.- Parameters:
resourceUserProvidedIdentifiers
- value to be set- Returns:
- Builder
-
deliveryId
Unique identifier of the Delivery.
- Parameters:
deliveryId
- value to be set- Returns:
- Builder
-
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
The Tracking Data that was added to the Parcel.
- Parameters:
trackingData
- value to be set- Returns:
- Builder
-
shippingKey
User-defined unique identifier of the Shipping Method in a Cart with
Multiple
ShippingMode.- Parameters:
shippingKey
- value to be set- Returns:
- Builder
-
getId
Unique identifier of the Message. Can be used to track which Messages have been processed.
- Returns:
- id
-
getVersion
Version of a resource. In case of Messages, this is always
1
.- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Message was generated.
- Returns:
- createdAt
-
getLastModifiedAt
Value of
createdAt
.- Returns:
- lastModifiedAt
-
getLastModifiedBy
IDs and references that last modified the Message.
- Returns:
- lastModifiedBy
-
getCreatedBy
IDs and references that created the Message.
- Returns:
- createdBy
-
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 thesequenceNumber
of the current Message. Meaning, thesequenceNumber
of the next Message equals thesequenceNumber
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
Reference to the resource on which the change or action was performed.
- Returns:
- resource
-
getResourceVersion
Version of the resource on which the change or action was performed.
- Returns:
- resourceVersion
-
getResourceUserProvidedIdentifiers
User-provided identifiers of the resource, such as
key
orexternalId
. Only present if the resource has such identifiers.- Returns:
- resourceUserProvidedIdentifiers
-
getDeliveryId
Unique identifier of the Delivery.
- Returns:
- deliveryId
-
getParcelId
Unique identifier of the Parcel.
- Returns:
- parcelId
-
getTrackingData
The Tracking Data that was added to the Parcel.
- Returns:
- trackingData
-
getShippingKey
User-defined unique identifier of the Shipping Method in a Cart with
Multiple
ShippingMode.- Returns:
- shippingKey
-
build
builds ParcelTrackingDataUpdatedMessage with checking for non-null required values- Specified by:
build
in interfaceBuilder<ParcelTrackingDataUpdatedMessage>
- Returns:
- ParcelTrackingDataUpdatedMessage
-
buildUnchecked
builds ParcelTrackingDataUpdatedMessage without checking for non-null required values- Returns:
- ParcelTrackingDataUpdatedMessage
-
of
factory method for an instance of ParcelTrackingDataUpdatedMessageBuilder- Returns:
- builder
-
of
create builder for ParcelTrackingDataUpdatedMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-