Class OrderEstimatedDeliverySetMessageBuilder
- All Implemented Interfaces:
Builder<OrderEstimatedDeliverySetMessage>
Example to create an instance using the builder pattern
OrderEstimatedDeliverySetMessage orderEstimatedDeliverySetMessage = OrderEstimatedDeliverySetMessage.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)
.build()
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()builds OrderEstimatedDeliverySetMessage with checking for non-null required valuesbuilds OrderEstimatedDeliverySetMessage 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.estimatedDelivery(EstimatedDelivery estimatedDelivery) Estimated delivery window on the Order after the Set Estimated Delivery update action.Estimated delivery window on the Order after the Set Estimated Delivery update action.Date and time (UTC) the Message was generated.IDs and references that created the Message.Estimated delivery window on the Order after the Set Estimated Delivery update action.getId()Unique identifier of the Message.Value ofcreatedAt.IDs and references that last modified the Message.Reference to the resource on which the change or action was performed.User-provided identifiers of the resource, such askeyorexternalId.Version of the resource on which the change or action was performed.Message number in relation to other Messages for a given resource.keyof the Shipping that was updated.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 OrderEstimatedDeliverySetMessageBuilderof(OrderEstimatedDeliverySetMessage template) create builder for OrderEstimatedDeliverySetMessage instanceReference 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 askeyorexternalId.resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiersBuilder> builder) User-provided identifiers of the resource, such askeyorexternalId.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) keyof the Shipping that was updated.Version of a resource.withCreatedBy(Function<CreatedByBuilder, CreatedBy> builder) IDs and references that created the Message.Estimated delivery window on the Order after the Set Estimated Delivery update action.IDs and references that last modified the Message.withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askeyorexternalId.
-
Constructor Details
-
OrderEstimatedDeliverySetMessageBuilder
public OrderEstimatedDeliverySetMessageBuilder()
-
-
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 OrderEstimatedDeliverySetMessageBuilder 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 OrderEstimatedDeliverySetMessageBuilder 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 OrderEstimatedDeliverySetMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy) IDs and references that last modified the Message.
- Parameters:
lastModifiedBy- value to be set- Returns:
- Builder
-
createdBy
public OrderEstimatedDeliverySetMessageBuilder createdBy(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Message.
- Parameters:
builder- function to build the createdBy value- Returns:
- Builder
-
withCreatedBy
public OrderEstimatedDeliverySetMessageBuilder 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
sequenceNumberof the next Message for the resource is the successor of thesequenceNumberof the current Message. Meaning, thesequenceNumberof the next Message equals thesequenceNumberof the current Message + 1.sequenceNumbercan 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 OrderEstimatedDeliverySetMessageBuilder 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 OrderEstimatedDeliverySetMessageBuilder resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiersBuilder> builder) User-provided identifiers of the resource, such as
keyorexternalId. Only present if the resource has such identifiers.- Parameters:
builder- function to build the resourceUserProvidedIdentifiers value- Returns:
- Builder
-
withResourceUserProvidedIdentifiers
public OrderEstimatedDeliverySetMessageBuilder withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such as
keyorexternalId. Only present if the resource has such identifiers.- Parameters:
builder- function to build the resourceUserProvidedIdentifiers value- Returns:
- Builder
-
resourceUserProvidedIdentifiers
public OrderEstimatedDeliverySetMessageBuilder resourceUserProvidedIdentifiers(@Nullable UserProvidedIdentifiers resourceUserProvidedIdentifiers) User-provided identifiers of the resource, such as
keyorexternalId. Only present if the resource has such identifiers.- Parameters:
resourceUserProvidedIdentifiers- value to be set- Returns:
- Builder
-
estimatedDelivery
public OrderEstimatedDeliverySetMessageBuilder estimatedDelivery(Function<EstimatedDeliveryBuilder, EstimatedDeliveryBuilder> builder) Estimated delivery window on the Order after the Set Estimated Delivery update action.
- Parameters:
builder- function to build the estimatedDelivery value- Returns:
- Builder
-
withEstimatedDelivery
public OrderEstimatedDeliverySetMessageBuilder withEstimatedDelivery(Function<EstimatedDeliveryBuilder, EstimatedDelivery> builder) Estimated delivery window on the Order after the Set Estimated Delivery update action.
- Parameters:
builder- function to build the estimatedDelivery value- Returns:
- Builder
-
estimatedDelivery
public OrderEstimatedDeliverySetMessageBuilder estimatedDelivery(@Nullable EstimatedDelivery estimatedDelivery) Estimated delivery window on the Order after the Set Estimated Delivery update action.
- Parameters:
estimatedDelivery- value to be set- Returns:
- Builder
-
shippingKey
keyof the Shipping that was updated. Only present for Orders withMultipleShippingMode.- 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
sequenceNumberof the next Message for the resource is the successor of thesequenceNumberof the current Message. Meaning, thesequenceNumberof the next Message equals thesequenceNumberof the current Message + 1.sequenceNumbercan 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
keyorexternalId. Only present if the resource has such identifiers.- Returns:
- resourceUserProvidedIdentifiers
-
getEstimatedDelivery
Estimated delivery window on the Order after the Set Estimated Delivery update action.
- Returns:
- estimatedDelivery
-
getShippingKey
keyof the Shipping that was updated. Only present for Orders withMultipleShippingMode.- Returns:
- shippingKey
-
build
builds OrderEstimatedDeliverySetMessage with checking for non-null required values- Specified by:
buildin interfaceBuilder<OrderEstimatedDeliverySetMessage>- Returns:
- OrderEstimatedDeliverySetMessage
-
buildUnchecked
builds OrderEstimatedDeliverySetMessage without checking for non-null required values- Returns:
- OrderEstimatedDeliverySetMessage
-
of
factory method for an instance of OrderEstimatedDeliverySetMessageBuilder- Returns:
- builder
-
of
create builder for OrderEstimatedDeliverySetMessage instance- Parameters:
template- instance with prefilled values for the builder- Returns:
- builder
-