Class ParcelRemovedFromDeliveryMessageBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<ParcelRemovedFromDeliveryMessage>
Example to create an instance using the builder pattern
ParcelRemovedFromDeliveryMessage parcelRemovedFromDeliveryMessage = ParcelRemovedFromDeliveryMessage.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}")
.parcel(parcelBuilder -> parcelBuilder)
.build()
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds ParcelRemovedFromDeliveryMessage with checking for non-null required valuesbuilds ParcelRemovedFromDeliveryMessage 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.Value ofcreatedAt
.Value ofcreatedBy
.Parcel that was removed from the Delivery.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.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) Value ofcreatedBy
.Value ofcreatedBy
.of()
factory method for an instance of ParcelRemovedFromDeliveryMessageBuilderof
(ParcelRemovedFromDeliveryMessage template) create builder for ParcelRemovedFromDeliveryMessage instanceParcel that was removed from the Delivery.parcel
(Function<ParcelBuilder, ParcelBuilder> builder) Parcel that was removed from the Delivery.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.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.Value ofcreatedBy
.withParcel
(Function<ParcelBuilder, Parcel> builder) Parcel that was removed from the Delivery.withResourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askey
orexternalId
.
-
Constructor Details
-
ParcelRemovedFromDeliveryMessageBuilder
-
-
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 ParcelRemovedFromDeliveryMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder, LastModifiedByBuilder> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
withLastModifiedBy
public ParcelRemovedFromDeliveryMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder, LastModifiedBy> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
lastModifiedBy
public ParcelRemovedFromDeliveryMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy) Value of
createdBy
.- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
public ParcelRemovedFromDeliveryMessageBuilder 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 ParcelRemovedFromDeliveryMessageBuilder 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
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 ParcelRemovedFromDeliveryMessageBuilder 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 ParcelRemovedFromDeliveryMessageBuilder 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 ParcelRemovedFromDeliveryMessageBuilder 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 ParcelRemovedFromDeliveryMessageBuilder 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
-
parcel
public ParcelRemovedFromDeliveryMessageBuilder parcel(Function<ParcelBuilder, ParcelBuilder> builder) Parcel that was removed from the Delivery.
- Parameters:
builder
- function to build the parcel value- Returns:
- Builder
-
withParcel
Parcel that was removed from the Delivery.
- Parameters:
builder
- function to build the parcel value- Returns:
- Builder
-
parcel
Parcel that was removed from the Delivery.
- Parameters:
parcel
- value to be set- 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
-
getDeliveryId
Unique identifier of the Delivery.
- Returns:
- deliveryId
-
getParcel
Parcel that was removed from the Delivery.
- Returns:
- parcel
-
getShippingKey
User-defined unique identifier of the Shipping Method in a Cart with
Multi
ShippingMode.- Returns:
- shippingKey
-
build
builds ParcelRemovedFromDeliveryMessage with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<ParcelRemovedFromDeliveryMessage>
- Returns:
- ParcelRemovedFromDeliveryMessage
-
buildUnchecked
builds ParcelRemovedFromDeliveryMessage without checking for non-null required values- Returns:
- ParcelRemovedFromDeliveryMessage
-
of
factory method for an instance of ParcelRemovedFromDeliveryMessageBuilder- Returns:
- builder
-
of
create builder for ParcelRemovedFromDeliveryMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-