Package com.commercetools.api.models.message

Class DeliveryAddedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.DeliveryAddedMessageBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<DeliveryAddedMessage>

public class DeliveryAddedMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<DeliveryAddedMessage>

DeliveryAddedMessageBuilder Example to create an instance using the builder pattern

     DeliveryAddedMessage deliveryAddedMessage = DeliveryAddedMessage.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)
             .delivery(deliveryBuilder -> deliveryBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
DeliveryAddedMessageBuilder()

Method Summary

Modifier and Type	Method	Description
DeliveryAddedMessage	build()	builds DeliveryAddedMessage with checking for non-null required values
DeliveryAddedMessage	buildUnchecked()	builds DeliveryAddedMessage without checking for non-null required values
DeliveryAddedMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
DeliveryAddedMessageBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
DeliveryAddedMessageBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DeliveryAddedMessageBuilder	delivery(Delivery delivery)	Delivery that was added to the Order.
DeliveryAddedMessageBuilder	delivery(Function<DeliveryBuilder,DeliveryBuilder> builder)	Delivery that was added to the Order.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Message was generated.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
Delivery	getDelivery()	Delivery that was added to the Order.
String	getId()	Unique identifier of the Message.
ZonedDateTime	getLastModifiedAt()	Value of createdAt.
LastModifiedBy	getLastModifiedBy()	Value of createdBy.
Reference	getResource()	Reference to the resource on which the change or action was performed.
UserProvidedIdentifiers	getResourceUserProvidedIdentifiers()	User-provided identifiers of the resource, such as key or externalId.
Long	getResourceVersion()	Version of the resource on which the change or action was performed.
Long	getSequenceNumber()	Message number in relation to other Messages for a given resource.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
Long	getVersion()	Version of a resource.
DeliveryAddedMessageBuilder	id(String id)	Unique identifier of the Message.
DeliveryAddedMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
DeliveryAddedMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Value of createdBy.
DeliveryAddedMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Value of createdBy.
static DeliveryAddedMessageBuilder	of()	factory method for an instance of DeliveryAddedMessageBuilder
static DeliveryAddedMessageBuilder	of(DeliveryAddedMessage template)	create builder for DeliveryAddedMessage instance
DeliveryAddedMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
DeliveryAddedMessageBuilder	resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
DeliveryAddedMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
DeliveryAddedMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
DeliveryAddedMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
DeliveryAddedMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
DeliveryAddedMessageBuilder	shippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
DeliveryAddedMessageBuilder	version(Long version)	Version of a resource.
DeliveryAddedMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DeliveryAddedMessageBuilder	withDelivery(Function<DeliveryBuilder,Delivery> builder)	Delivery that was added to the Order.
DeliveryAddedMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Value of createdBy.
DeliveryAddedMessageBuilder	withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)	User-provided identifiers of the resource, such as key or externalId.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DeliveryAddedMessageBuilder

public DeliveryAddedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public DeliveryAddedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public DeliveryAddedMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

delivery

public DeliveryAddedMessageBuilder delivery(Function<DeliveryBuilder,DeliveryBuilder> builder)

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional ParcelAddedToDelivery Message containing information about the Parcels.

Parameters:

builder - function to build the delivery value

Returns:

Builder

withDelivery

public DeliveryAddedMessageBuilder withDelivery(Function<DeliveryBuilder,Delivery> builder)

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional ParcelAddedToDelivery Message containing information about the Parcels.

Parameters:

builder - function to build the delivery value

Returns:

Builder

delivery

public DeliveryAddedMessageBuilder delivery(Delivery delivery)

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional ParcelAddedToDelivery Message containing information about the Parcels.

Parameters:

delivery - value to be set

Returns:

Builder

shippingKey

public DeliveryAddedMessageBuilder shippingKey(@Nullable
 String shippingKey)

User-defined unique identifier of the Shipping Method in a Cart with Multi 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

getDelivery

public Delivery getDelivery()

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional ParcelAddedToDelivery Message containing information about the Parcels.

Returns:

delivery

getShippingKey

@Nullable
public String getShippingKey()

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

Returns:

shippingKey

build

public DeliveryAddedMessage build()

builds DeliveryAddedMessage with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<DeliveryAddedMessage>

Returns:

DeliveryAddedMessage

buildUnchecked

public DeliveryAddedMessage buildUnchecked()

builds DeliveryAddedMessage without checking for non-null required values

Returns:

DeliveryAddedMessage

of

public static DeliveryAddedMessageBuilder of()

factory method for an instance of DeliveryAddedMessageBuilder

Returns:

builder

of

public static DeliveryAddedMessageBuilder of(DeliveryAddedMessage template)

create builder for DeliveryAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder