Package com.commercetools.api.models.message

Interface ParcelAddedToDeliveryMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface ParcelAddedToDeliveryMessagePayload
extends OrderMessagePayload

Generated after a successful Add Parcel to Delivery update action.

Example to create an instance using the builder pattern

     ParcelAddedToDeliveryMessagePayload parcelAddedToDeliveryMessagePayload = ParcelAddedToDeliveryMessagePayload.builder()
             .delivery(deliveryBuilder -> deliveryBuilder)
             .parcel(parcelBuilder -> parcelBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARCEL_ADDED_TO_DELIVERY	discriminator value for ParcelAddedToDeliveryMessagePayload

Method Summary

Modifier and Type	Method	Description
static ParcelAddedToDeliveryMessagePayloadBuilder	builder()	builder factory method for ParcelAddedToDeliveryMessagePayload
static ParcelAddedToDeliveryMessagePayloadBuilder	builder(ParcelAddedToDeliveryMessagePayload template)	create builder for ParcelAddedToDeliveryMessagePayload instance
ParcelAddedToDeliveryMessagePayload	copyDeep()
static ParcelAddedToDeliveryMessagePayload	deepCopy(ParcelAddedToDeliveryMessagePayload template)	factory method to create a deep copy of ParcelAddedToDeliveryMessagePayload
@NotNull @Valid Delivery	getDelivery()	Unique identifier of the Delivery.
@NotNull @Valid Parcel	getParcel()	Parcel that was added to the Delivery.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static ParcelAddedToDeliveryMessagePayload	of()	factory method
static ParcelAddedToDeliveryMessagePayload	of(ParcelAddedToDeliveryMessagePayload template)	factory method to create a shallow copy ParcelAddedToDeliveryMessagePayload
void	setDelivery(Delivery delivery)	Unique identifier of the Delivery.
void	setParcel(Parcel parcel)	Parcel that was added to the Delivery.
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<ParcelAddedToDeliveryMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withParcelAddedToDeliveryMessagePayload(Function<ParcelAddedToDeliveryMessagePayload,T> helper)	accessor map function

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

getType, withMessagePayload

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

as

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

withOrderMessagePayload

Field Details

PARCEL_ADDED_TO_DELIVERY

static final String PARCEL_ADDED_TO_DELIVERY

discriminator value for ParcelAddedToDeliveryMessagePayload

See Also:

• Constant Field Values

Method Details

getDelivery

@NotNull
@Valid
@NotNull @Valid Delivery getDelivery()

Unique identifier of the Delivery.

Returns:

delivery

getParcel

@NotNull
@Valid
@NotNull @Valid Parcel getParcel()

Parcel that was added to the Delivery.

Returns:

parcel

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDelivery

void setDelivery(Delivery delivery)

Unique identifier of the Delivery.

Parameters:

delivery - value to be set

setParcel

void setParcel(Parcel parcel)

Parcel that was added to the Delivery.

Parameters:

parcel - 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 ParcelAddedToDeliveryMessagePayload of()

factory method

Returns:

instance of ParcelAddedToDeliveryMessagePayload

of

static ParcelAddedToDeliveryMessagePayload of(ParcelAddedToDeliveryMessagePayload template)

factory method to create a shallow copy ParcelAddedToDeliveryMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ParcelAddedToDeliveryMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static ParcelAddedToDeliveryMessagePayload deepCopy(@Nullable
 ParcelAddedToDeliveryMessagePayload template)

factory method to create a deep copy of ParcelAddedToDeliveryMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ParcelAddedToDeliveryMessagePayloadBuilder builder()

builder factory method for ParcelAddedToDeliveryMessagePayload

Returns:

builder

builder

static ParcelAddedToDeliveryMessagePayloadBuilder builder(ParcelAddedToDeliveryMessagePayload template)

create builder for ParcelAddedToDeliveryMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withParcelAddedToDeliveryMessagePayload

default <T> T withParcelAddedToDeliveryMessagePayload(Function<ParcelAddedToDeliveryMessagePayload,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<ParcelAddedToDeliveryMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference