Package com.commercetools.api.models.message

Interface DeliveryAddressSetMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

public interface DeliveryAddressSetMessage
extends OrderMessage

Generated after a successful Set Delivery Address update action.

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()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_ADDRESS_SET	discriminator value for DeliveryAddressSetMessage

Method Summary

Modifier and Type	Method	Description
static DeliveryAddressSetMessageBuilder	builder()	builder factory method for DeliveryAddressSetMessage
static DeliveryAddressSetMessageBuilder	builder(DeliveryAddressSetMessage template)	create builder for DeliveryAddressSetMessage instance
DeliveryAddressSetMessage	copyDeep()
static DeliveryAddressSetMessage	deepCopy(DeliveryAddressSetMessage template)	factory method to create a deep copy of DeliveryAddressSetMessage
@Valid Address	getAddress()	Address after the Set Delivery Address update action.
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@Valid Address	getOldAddress()	Address before the Set Delivery Address update action.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static DeliveryAddressSetMessage	of()	factory method
static DeliveryAddressSetMessage	of(DeliveryAddressSetMessage template)	factory method to create a shallow copy DeliveryAddressSetMessage
void	setAddress(Address address)	Address after the Set Delivery Address update action.
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setOldAddress(Address oldAddress)	Address before the Set Delivery Address update action.
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryAddressSetMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryAddressSetMessage(Function<DeliveryAddressSetMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Methods inherited from interface com.commercetools.api.models.message.OrderMessage

withOrderMessage

Field Details

DELIVERY_ADDRESS_SET

static final String DELIVERY_ADDRESS_SET

discriminator value for DeliveryAddressSetMessage

See Also:

• Constant Field Values

Method Details

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

getAddress

@Valid
@Valid Address getAddress()

Address after the Set Delivery Address update action.

Returns:

address

getOldAddress

@Valid
@Valid Address getOldAddress()

Address before the Set Delivery Address update action.

Returns:

oldAddress

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

setAddress

void setAddress(Address address)

Address after the Set Delivery Address update action.

Parameters:

address - value to be set

setOldAddress

void setOldAddress(Address oldAddress)

Address before the Set Delivery Address update action.

Parameters:

oldAddress - value to be set

setShippingKey

void setShippingKey(String shippingKey)

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

Parameters:

shippingKey - value to be set

of

static DeliveryAddressSetMessage of()

factory method

Returns:

instance of DeliveryAddressSetMessage

of

static DeliveryAddressSetMessage of(DeliveryAddressSetMessage template)

factory method to create a shallow copy DeliveryAddressSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryAddressSetMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static DeliveryAddressSetMessage deepCopy(@Nullable
 DeliveryAddressSetMessage template)

factory method to create a deep copy of DeliveryAddressSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryAddressSetMessageBuilder builder()

builder factory method for DeliveryAddressSetMessage

Returns:

builder

builder

static DeliveryAddressSetMessageBuilder builder(DeliveryAddressSetMessage template)

create builder for DeliveryAddressSetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryAddressSetMessage

default <T> T withDeliveryAddressSetMessage(Function<DeliveryAddressSetMessage,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<DeliveryAddressSetMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference