Class ParcelItemsUpdatedMessageBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<ParcelItemsUpdatedMessage>
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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddItems
(Function<DeliveryItemBuilder, DeliveryItem> builder) Delivery Items after the Set Parcel Items update action.addOldItems
(Function<DeliveryItemBuilder, DeliveryItem> builder) Delivery Items before the Set Parcel Items update action.build()
builds ParcelItemsUpdatedMessage with checking for non-null required valuesbuilds ParcelItemsUpdatedMessage without checking for non-null required valuescreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Message was generated.Present on resources created after 1 February 2019 except for events not tracked.createdBy
(Function<CreatedByBuilder, CreatedByBuilder> builder) Present on resources created after 1 February 2019 except for events not tracked.deliveryId
(String deliveryId) Unique identifier of the Delivery.Date and time (UTC) the Message was generated.Present on resources created after 1 February 2019 except for events not tracked.Unique identifier of the Delivery.getId()
Unique identifier of the Message.getItems()
Delivery Items after the Set Parcel Items update action.Value ofcreatedAt
.Value ofcreatedBy
.Delivery Items before the Set Parcel Items update action.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 withMulti
ShippingMode.Version of a resource.Unique identifier of the Message.items
(DeliveryItem... items) Delivery Items after the Set Parcel Items update action.items
(List<DeliveryItem> items) Delivery Items after the Set Parcel Items update action.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) Value ofcreatedBy
.Value ofcreatedBy
.of()
factory method for an instance of ParcelItemsUpdatedMessageBuilderof
(ParcelItemsUpdatedMessage template) create builder for ParcelItemsUpdatedMessage instanceoldItems
(DeliveryItem... oldItems) Delivery Items before the Set Parcel Items update action.oldItems
(List<DeliveryItem> oldItems) Delivery Items before the Set Parcel Items update action.Unique identifier of the Parcel.plusItems
(DeliveryItem... items) Delivery Items after the Set Parcel Items update action.Delivery Items after the Set Parcel Items update action.plusOldItems
(DeliveryItem... oldItems) Delivery Items before the Set Parcel Items update action.Delivery Items before the Set Parcel Items update action.Reference to the resource on which the change or action was performed.resource
(Function<ReferenceBuilder, io.vrap.rmf.base.client.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.setItems
(Function<DeliveryItemBuilder, DeliveryItem> builder) Delivery Items after the Set Parcel Items update action.setOldItems
(Function<DeliveryItemBuilder, DeliveryItem> builder) Delivery Items before the Set Parcel Items update action.shippingKey
(String shippingKey) User-defined unique identifier of the Shipping Method in a Cart withMulti
ShippingMode.Version of a resource.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) Present on resources created after 1 February 2019 except for events not tracked.Delivery Items after the Set Parcel Items update action.Value ofcreatedBy
.Delivery Items before the Set Parcel Items update action.withResourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askey
orexternalId
.
-
Constructor Details
-
ParcelItemsUpdatedMessageBuilder
public ParcelItemsUpdatedMessageBuilder()
-
-
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 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
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
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
createdBy
Present on resources created after 1 February 2019 except for events not tracked.
- 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 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
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
orexternalId
. 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
orexternalId
. 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
orexternalId
. Only present if the resource has such identifiers.- Parameters:
resourceUserProvidedIdentifiers
- value to be set- Returns:
- Builder
-
parcelId
Unique identifier of the Parcel.
- Parameters:
parcelId
- value to be set- Returns:
- Builder
-
deliveryId
Unique identifier of the Delivery.
- Parameters:
deliveryId
- value to be set- Returns:
- Builder
-
items
Delivery Items after the Set Parcel Items update action.
- Parameters:
items
- value to be set- Returns:
- Builder
-
items
Delivery Items after the Set Parcel Items update action.
- Parameters:
items
- value to be set- Returns:
- Builder
-
plusItems
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
Delivery Items before the Set Parcel Items update action.
- Parameters:
oldItems
- value to be set- Returns:
- Builder
-
oldItems
Delivery Items before the Set Parcel Items update action.
- Parameters:
oldItems
- value to be set- Returns:
- Builder
-
plusOldItems
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
User-defined unique identifier of the Shipping Method in a Cart with
Multi
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
Value of
createdBy
.- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- 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
-
getParcelId
Unique identifier of the Parcel.
- Returns:
- parcelId
-
getDeliveryId
Unique identifier of the Delivery.
- Returns:
- deliveryId
-
getItems
Delivery Items after the Set Parcel Items update action.
- Returns:
- items
-
getOldItems
Delivery Items before the Set Parcel Items update action.
- Returns:
- oldItems
-
getShippingKey
User-defined unique identifier of the Shipping Method in a Cart with
Multi
ShippingMode.- Returns:
- shippingKey
-
build
builds ParcelItemsUpdatedMessage with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<ParcelItemsUpdatedMessage>
- Returns:
- ParcelItemsUpdatedMessage
-
buildUnchecked
builds ParcelItemsUpdatedMessage without checking for non-null required values- Returns:
- ParcelItemsUpdatedMessage
-
of
factory method for an instance of ParcelItemsUpdatedMessageBuilder- Returns:
- builder
-
of
create builder for ParcelItemsUpdatedMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-