Package com.commercetools.api.models.message

Interface DeliveryCustomTypeSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface DeliveryCustomTypeSetMessagePayload
extends OrderMessagePayload

Generated after adding a Custom Type to a Delivery using the Set Custom Type update action.

Example to create an instance using the builder pattern

     DeliveryCustomTypeSetMessagePayload deliveryCustomTypeSetMessagePayload = DeliveryCustomTypeSetMessagePayload.builder()
             .customFields(customFieldsBuilder -> customFieldsBuilder)
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_CUSTOM_TYPE_SET	discriminator value for DeliveryCustomTypeSetMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomTypeSetMessagePayloadBuilder	builder()	builder factory method for DeliveryCustomTypeSetMessagePayload
static DeliveryCustomTypeSetMessagePayloadBuilder	builder(DeliveryCustomTypeSetMessagePayload template)	create builder for DeliveryCustomTypeSetMessagePayload instance
DeliveryCustomTypeSetMessagePayload	copyDeep()
static DeliveryCustomTypeSetMessagePayload	deepCopy(DeliveryCustomTypeSetMessagePayload template)	factory method to create a deep copy of DeliveryCustomTypeSetMessagePayload
@NotNull @Valid CustomFields	getCustomFields()	The Custom Fields that have been set.
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
String	getPreviousTypeId()	id of the previous Custom Type.
static DeliveryCustomTypeSetMessagePayload	of()	factory method
static DeliveryCustomTypeSetMessagePayload	of(DeliveryCustomTypeSetMessagePayload template)	factory method to create a shallow copy DeliveryCustomTypeSetMessagePayload
void	setCustomFields(CustomFields customFields)	The Custom Fields that have been set.
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setPreviousTypeId(String previousTypeId)	id of the previous Custom Type.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryCustomTypeSetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomTypeSetMessagePayload(Function<DeliveryCustomTypeSetMessagePayload,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_SET

static final String DELIVERY_CUSTOM_TYPE_SET

discriminator value for DeliveryCustomTypeSetMessagePayload

See Also:

• Constant Field Values

Method Details

getCustomFields

@NotNull
@Valid
@NotNull @Valid CustomFields getCustomFields()

The Custom Fields that have been set.

Returns:

customFields

getPreviousTypeId

String getPreviousTypeId()

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

Returns:

previousTypeId

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

setCustomFields

void setCustomFields(CustomFields customFields)

The Custom Fields that have been set.

Parameters:

customFields - value to be set

setPreviousTypeId

void setPreviousTypeId(String previousTypeId)

id of the previous Custom Type. 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 DeliveryCustomTypeSetMessagePayload of()

factory method

Returns:

instance of DeliveryCustomTypeSetMessagePayload

of

static DeliveryCustomTypeSetMessagePayload of(DeliveryCustomTypeSetMessagePayload template)

factory method to create a shallow copy DeliveryCustomTypeSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryCustomTypeSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static DeliveryCustomTypeSetMessagePayload deepCopy(@Nullable
 DeliveryCustomTypeSetMessagePayload template)

factory method to create a deep copy of DeliveryCustomTypeSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomTypeSetMessagePayloadBuilder builder()

builder factory method for DeliveryCustomTypeSetMessagePayload

Returns:

builder

builder

static DeliveryCustomTypeSetMessagePayloadBuilder builder(DeliveryCustomTypeSetMessagePayload template)

create builder for DeliveryCustomTypeSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomTypeSetMessagePayload

default <T> T withDeliveryCustomTypeSetMessagePayload(Function<DeliveryCustomTypeSetMessagePayload,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<DeliveryCustomTypeSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference