Package com.commercetools.api.models.message

Interface DeliveryCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface DeliveryCustomFieldAddedMessagePayload
extends OrderMessagePayload

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

Example to create an instance using the builder pattern

     DeliveryCustomFieldAddedMessagePayload deliveryCustomFieldAddedMessagePayload = DeliveryCustomFieldAddedMessagePayload.builder()
             .name("{name}")
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_CUSTOM_FIELD_ADDED	discriminator value for DeliveryCustomFieldAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomFieldAddedMessagePayloadBuilder	builder()	builder factory method for DeliveryCustomFieldAddedMessagePayload
static DeliveryCustomFieldAddedMessagePayloadBuilder	builder(DeliveryCustomFieldAddedMessagePayload template)	create builder for DeliveryCustomFieldAddedMessagePayload instance
static DeliveryCustomFieldAddedMessagePayload	deepCopy(DeliveryCustomFieldAddedMessagePayload template)	factory method to create a deep copy of DeliveryCustomFieldAddedMessagePayload
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@NotNull String	getName()	Name of the Custom Field that was added.
@NotNull Object	getValue()	The added CustomFieldValue based on the FieldType.
static DeliveryCustomFieldAddedMessagePayload	of()	factory method
static DeliveryCustomFieldAddedMessagePayload	of(DeliveryCustomFieldAddedMessagePayload template)	factory method to create a shallow copy DeliveryCustomFieldAddedMessagePayload
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setName(String name)	Name of the Custom Field that was added.
void	setValue(Object value)	The added CustomFieldValue based on the FieldType.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryCustomFieldAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomFieldAddedMessagePayload(Function<DeliveryCustomFieldAddedMessagePayload,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_FIELD_ADDED

static final String DELIVERY_CUSTOM_FIELD_ADDED

discriminator value for DeliveryCustomFieldAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that was added.

Returns:

name

getValue

@NotNull
@NotNull Object getValue()

The added CustomFieldValue based on the FieldType.

Returns:

value

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

setName

void setName(String name)

Name of the Custom Field that was added.

Parameters:

name - value to be set

setValue

void setValue(Object value)

The added CustomFieldValue based on the FieldType.

Parameters:

value - value to be set

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

of

static DeliveryCustomFieldAddedMessagePayload of()

factory method

Returns:

instance of DeliveryCustomFieldAddedMessagePayload

of

static DeliveryCustomFieldAddedMessagePayload of(DeliveryCustomFieldAddedMessagePayload template)

factory method to create a shallow copy DeliveryCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static DeliveryCustomFieldAddedMessagePayload deepCopy(@Nullable
 DeliveryCustomFieldAddedMessagePayload template)

factory method to create a deep copy of DeliveryCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for DeliveryCustomFieldAddedMessagePayload

Returns:

builder

builder

static DeliveryCustomFieldAddedMessagePayloadBuilder builder(DeliveryCustomFieldAddedMessagePayload template)

create builder for DeliveryCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomFieldAddedMessagePayload

default <T> T withDeliveryCustomFieldAddedMessagePayload(Function<DeliveryCustomFieldAddedMessagePayload,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<DeliveryCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference