Package com.commercetools.api.models.message

Class DeliveryAddressSetMessageBuilder

java.lang.Object

com.commercetools.api.models.message.DeliveryAddressSetMessageBuilder

All Implemented Interfaces:

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

public class DeliveryAddressSetMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<DeliveryAddressSetMessage>

DeliveryAddressSetMessageBuilder Example to create an instance using the builder pattern

     DeliveryAddressSetMessage deliveryAddressSetMessage = DeliveryAddressSetMessage.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}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
DeliveryAddressSetMessageBuilder()

Method Summary

Modifier and Type	Method	Description
DeliveryAddressSetMessageBuilder	address(Address address)	Address after the Set Delivery Address update action.
DeliveryAddressSetMessageBuilder	address(Function<AddressBuilder,AddressBuilder> builder)	Address after the Set Delivery Address update action.
DeliveryAddressSetMessage	build()	builds DeliveryAddressSetMessage with checking for non-null required values
DeliveryAddressSetMessage	buildUnchecked()	builds DeliveryAddressSetMessage without checking for non-null required values
DeliveryAddressSetMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
DeliveryAddressSetMessageBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
DeliveryAddressSetMessageBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DeliveryAddressSetMessageBuilder	deliveryId(String deliveryId)	Unique identifier of the Parcel.
Address	getAddress()	Address after the Set Delivery Address update action.
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.
String	getDeliveryId()	Unique identifier of the Parcel.
String	getId()	Unique identifier of the Message.
ZonedDateTime	getLastModifiedAt()	Value of createdAt.
LastModifiedBy	getLastModifiedBy()	Value of createdBy.
Address	getOldAddress()	Address before the Set Delivery Address update action.
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 Multiple ShippingMode.
Long	getVersion()	Version of a resource.
DeliveryAddressSetMessageBuilder	id(String id)	Unique identifier of the Message.
DeliveryAddressSetMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
DeliveryAddressSetMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Value of createdBy.
DeliveryAddressSetMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Value of createdBy.
static DeliveryAddressSetMessageBuilder	of()	factory method for an instance of DeliveryAddressSetMessageBuilder
static DeliveryAddressSetMessageBuilder	of(DeliveryAddressSetMessage template)	create builder for DeliveryAddressSetMessage instance
DeliveryAddressSetMessageBuilder	oldAddress(Address oldAddress)	Address before the Set Delivery Address update action.
DeliveryAddressSetMessageBuilder	oldAddress(Function<AddressBuilder,AddressBuilder> builder)	Address before the Set Delivery Address update action.
DeliveryAddressSetMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
DeliveryAddressSetMessageBuilder	resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
DeliveryAddressSetMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
DeliveryAddressSetMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
DeliveryAddressSetMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
DeliveryAddressSetMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
DeliveryAddressSetMessageBuilder	shippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
DeliveryAddressSetMessageBuilder	version(Long version)	Version of a resource.
DeliveryAddressSetMessageBuilder	withAddress(Function<AddressBuilder,Address> builder)	Address after the Set Delivery Address update action.
DeliveryAddressSetMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DeliveryAddressSetMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Value of createdBy.
DeliveryAddressSetMessageBuilder	withOldAddress(Function<AddressBuilder,Address> builder)	Address before the Set Delivery Address update action.
DeliveryAddressSetMessageBuilder	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

DeliveryAddressSetMessageBuilder

public DeliveryAddressSetMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public DeliveryAddressSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public DeliveryAddressSetMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

deliveryId

public DeliveryAddressSetMessageBuilder deliveryId(String deliveryId)

Unique identifier of the Parcel.

Parameters:

deliveryId - value to be set

Returns:

Builder

address

public DeliveryAddressSetMessageBuilder address(Function<AddressBuilder,AddressBuilder> builder)

Address after the Set Delivery Address update action.

Parameters:

builder - function to build the address value

Returns:

Builder

withAddress

public DeliveryAddressSetMessageBuilder withAddress(Function<AddressBuilder,Address> builder)

Address after the Set Delivery Address update action.

Parameters:

builder - function to build the address value

Returns:

Builder

address

public DeliveryAddressSetMessageBuilder address(@Nullable
 Address address)

Address after the Set Delivery Address update action.

Parameters:

address - value to be set

Returns:

Builder

oldAddress

public DeliveryAddressSetMessageBuilder oldAddress(Function<AddressBuilder,AddressBuilder> builder)

Address before the Set Delivery Address update action.

Parameters:

builder - function to build the oldAddress value

Returns:

Builder

withOldAddress

public DeliveryAddressSetMessageBuilder withOldAddress(Function<AddressBuilder,Address> builder)

Address before the Set Delivery Address update action.

Parameters:

builder - function to build the oldAddress value

Returns:

Builder

oldAddress

public DeliveryAddressSetMessageBuilder oldAddress(@Nullable
 Address oldAddress)

Address before the Set Delivery Address update action.

Parameters:

oldAddress - value to be set

Returns:

Builder

shippingKey

public DeliveryAddressSetMessageBuilder shippingKey(@Nullable
 String shippingKey)

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

getDeliveryId

public String getDeliveryId()

Unique identifier of the Parcel.

Returns:

deliveryId

getAddress

@Nullable
public Address getAddress()

Address after the Set Delivery Address update action.

Returns:

address

getOldAddress

@Nullable
public Address getOldAddress()

Address before the Set Delivery Address update action.

Returns:

oldAddress

getShippingKey

@Nullable
public String getShippingKey()

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

Returns:

shippingKey

build

public DeliveryAddressSetMessage build()

builds DeliveryAddressSetMessage with checking for non-null required values

Specified by:

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

Returns:

DeliveryAddressSetMessage

buildUnchecked

public DeliveryAddressSetMessage buildUnchecked()

builds DeliveryAddressSetMessage without checking for non-null required values

Returns:

DeliveryAddressSetMessage

of

public static DeliveryAddressSetMessageBuilder of()

factory method for an instance of DeliveryAddressSetMessageBuilder

Returns:

builder

of

public static DeliveryAddressSetMessageBuilder of(DeliveryAddressSetMessage template)

create builder for DeliveryAddressSetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder