Package com.commercetools.api.models.message

Interface DeliveryCustomFieldRemovedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface DeliveryCustomFieldRemovedMessagePayload
extends OrderMessagePayload

Generated when a Custom Field has been removed from the Delivery using the Set CustomField update action.

Example to create an instance using the builder pattern

     DeliveryCustomFieldRemovedMessagePayload deliveryCustomFieldRemovedMessagePayload = DeliveryCustomFieldRemovedMessagePayload.builder()
             .name("{name}")
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_CUSTOM_FIELD_REMOVED	discriminator value for DeliveryCustomFieldRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomFieldRemovedMessagePayloadBuilder	builder()	builder factory method for DeliveryCustomFieldRemovedMessagePayload
static DeliveryCustomFieldRemovedMessagePayloadBuilder	builder(DeliveryCustomFieldRemovedMessagePayload template)	create builder for DeliveryCustomFieldRemovedMessagePayload instance
static DeliveryCustomFieldRemovedMessagePayload	deepCopy(DeliveryCustomFieldRemovedMessagePayload template)	factory method to create a deep copy of DeliveryCustomFieldRemovedMessagePayload
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@NotNull String	getName()	Name of the Custom Field that was removed.
static DeliveryCustomFieldRemovedMessagePayload	of()	factory method
static DeliveryCustomFieldRemovedMessagePayload	of(DeliveryCustomFieldRemovedMessagePayload template)	factory method to create a shallow copy DeliveryCustomFieldRemovedMessagePayload
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setName(String name)	Name of the Custom Field that was removed.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryCustomFieldRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomFieldRemovedMessagePayload(Function<DeliveryCustomFieldRemovedMessagePayload,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_REMOVED

static final String DELIVERY_CUSTOM_FIELD_REMOVED

discriminator value for DeliveryCustomFieldRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that was removed.

Returns:

name

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

setName

void setName(String name)

Name of the Custom Field that was removed.

Parameters:

name - value to be set

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

of

static DeliveryCustomFieldRemovedMessagePayload of()

factory method

Returns:

instance of DeliveryCustomFieldRemovedMessagePayload

of

static DeliveryCustomFieldRemovedMessagePayload of(DeliveryCustomFieldRemovedMessagePayload template)

factory method to create a shallow copy DeliveryCustomFieldRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static DeliveryCustomFieldRemovedMessagePayload deepCopy(@Nullable
 DeliveryCustomFieldRemovedMessagePayload template)

factory method to create a deep copy of DeliveryCustomFieldRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomFieldRemovedMessagePayloadBuilder builder()

builder factory method for DeliveryCustomFieldRemovedMessagePayload

Returns:

builder

builder

static DeliveryCustomFieldRemovedMessagePayloadBuilder builder(DeliveryCustomFieldRemovedMessagePayload template)

create builder for DeliveryCustomFieldRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomFieldRemovedMessagePayload

default <T> T withDeliveryCustomFieldRemovedMessagePayload(Function<DeliveryCustomFieldRemovedMessagePayload,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<DeliveryCustomFieldRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference