Package com.commercetools.api.models.message

Interface DeliveryRemovedMessagePayload

All Superinterfaces:

MessagePayload, OrderMessagePayload

All Known Implementing Classes:

DeliveryRemovedMessagePayloadImpl

public interface DeliveryRemovedMessagePayload
extends OrderMessagePayload

Generated after a successful Remove Delivery update action.

Example to create an instance using the builder pattern

     DeliveryRemovedMessagePayload deliveryRemovedMessagePayload = DeliveryRemovedMessagePayload.builder()
             .delivery(deliveryBuilder -> deliveryBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_REMOVED	discriminator value for DeliveryRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryRemovedMessagePayloadBuilder	builder()	builder factory method for DeliveryRemovedMessagePayload
static DeliveryRemovedMessagePayloadBuilder	builder(DeliveryRemovedMessagePayload template)	create builder for DeliveryRemovedMessagePayload instance
static DeliveryRemovedMessagePayload	deepCopy(DeliveryRemovedMessagePayload template)	factory method to create a deep copy of DeliveryRemovedMessagePayload
@NotNull @Valid Delivery	getDelivery()	The Delivery that was removed from the Order.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
static DeliveryRemovedMessagePayload	of()	factory method
static DeliveryRemovedMessagePayload	of(DeliveryRemovedMessagePayload template)	factory method to create a shallow copy DeliveryRemovedMessagePayload
void	setDelivery(Delivery delivery)	The Delivery that was removed from the Order.
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryRemovedMessagePayload(Function<DeliveryRemovedMessagePayload,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.OrderMessagePayload

withOrderMessagePayload

Field Details

DELIVERY_REMOVED

static final String DELIVERY_REMOVED

discriminator value for DeliveryRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getDelivery

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

The Delivery that was removed from the Order.

Returns:

delivery

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDelivery

void setDelivery(Delivery delivery)

The Delivery that was removed from the Order.

Parameters:

delivery - value to be set

setShippingKey

void setShippingKey(String shippingKey)

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

Parameters:

shippingKey - value to be set

of

static DeliveryRemovedMessagePayload of()

factory method

Returns:

instance of DeliveryRemovedMessagePayload

of

static DeliveryRemovedMessagePayload of(DeliveryRemovedMessagePayload template)

factory method to create a shallow copy DeliveryRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static DeliveryRemovedMessagePayload deepCopy(@Nullable
 DeliveryRemovedMessagePayload template)

factory method to create a deep copy of DeliveryRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryRemovedMessagePayloadBuilder builder()

builder factory method for DeliveryRemovedMessagePayload

Returns:

builder

builder

static DeliveryRemovedMessagePayloadBuilder builder(DeliveryRemovedMessagePayload template)

create builder for DeliveryRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryRemovedMessagePayload

default <T> T withDeliveryRemovedMessagePayload(Function<DeliveryRemovedMessagePayload,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<DeliveryRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference