Package com.commercetools.api.models.message

Interface DeliveryCustomTypeRemovedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface DeliveryCustomTypeRemovedMessagePayload
extends OrderMessagePayload

Generated after removing a Custom Type from a Delivery using the Set Custom Type update action with empty parameters.

Example to create an instance using the builder pattern

     DeliveryCustomTypeRemovedMessagePayload deliveryCustomTypeRemovedMessagePayload = DeliveryCustomTypeRemovedMessagePayload.builder()
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_CUSTOM_TYPE_REMOVED	discriminator value for DeliveryCustomTypeRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomTypeRemovedMessagePayloadBuilder	builder()	builder factory method for DeliveryCustomTypeRemovedMessagePayload
static DeliveryCustomTypeRemovedMessagePayloadBuilder	builder(DeliveryCustomTypeRemovedMessagePayload template)	create builder for DeliveryCustomTypeRemovedMessagePayload instance
static DeliveryCustomTypeRemovedMessagePayload	deepCopy(DeliveryCustomTypeRemovedMessagePayload template)	factory method to create a deep copy of DeliveryCustomTypeRemovedMessagePayload
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
String	getPreviousTypeId()	id of the Custom Type that was removed.
static DeliveryCustomTypeRemovedMessagePayload	of()	factory method
static DeliveryCustomTypeRemovedMessagePayload	of(DeliveryCustomTypeRemovedMessagePayload template)	factory method to create a shallow copy DeliveryCustomTypeRemovedMessagePayload
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setPreviousTypeId(String previousTypeId)	id of the Custom Type that was removed.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryCustomTypeRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomTypeRemovedMessagePayload(Function<DeliveryCustomTypeRemovedMessagePayload,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

DELIVERY_CUSTOM_TYPE_REMOVED

static final String DELIVERY_CUSTOM_TYPE_REMOVED

discriminator value for DeliveryCustomTypeRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getPreviousTypeId

String getPreviousTypeId()

id of the Custom Type that was removed. Absent if there was no previous Custom Type present.

Returns:

previousTypeId

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

setPreviousTypeId

void setPreviousTypeId(String previousTypeId)

id of the Custom Type that was removed. Absent if there was no previous Custom Type present.

Parameters:

previousTypeId - value to be set

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

of

static DeliveryCustomTypeRemovedMessagePayload of()

factory method

Returns:

instance of DeliveryCustomTypeRemovedMessagePayload

of

static DeliveryCustomTypeRemovedMessagePayload of(DeliveryCustomTypeRemovedMessagePayload template)

factory method to create a shallow copy DeliveryCustomTypeRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static DeliveryCustomTypeRemovedMessagePayload deepCopy(@Nullable
 DeliveryCustomTypeRemovedMessagePayload template)

factory method to create a deep copy of DeliveryCustomTypeRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomTypeRemovedMessagePayloadBuilder builder()

builder factory method for DeliveryCustomTypeRemovedMessagePayload

Returns:

builder

builder

static DeliveryCustomTypeRemovedMessagePayloadBuilder builder(DeliveryCustomTypeRemovedMessagePayload template)

create builder for DeliveryCustomTypeRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomTypeRemovedMessagePayload

default <T> T withDeliveryCustomTypeRemovedMessagePayload(Function<DeliveryCustomTypeRemovedMessagePayload,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<DeliveryCustomTypeRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference