Package com.commercetools.api.models.message

Interface DeliveryCustomFieldRemovedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

public interface DeliveryCustomFieldRemovedMessage
extends OrderMessage

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

     DeliveryCustomFieldRemovedMessage deliveryCustomFieldRemovedMessage = DeliveryCustomFieldRemovedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .name("{name}")
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomFieldRemovedMessageBuilder	builder()	builder factory method for DeliveryCustomFieldRemovedMessage
static DeliveryCustomFieldRemovedMessageBuilder	builder(DeliveryCustomFieldRemovedMessage template)	create builder for DeliveryCustomFieldRemovedMessage instance
DeliveryCustomFieldRemovedMessage	copyDeep()
static DeliveryCustomFieldRemovedMessage	deepCopy(DeliveryCustomFieldRemovedMessage template)	factory method to create a deep copy of DeliveryCustomFieldRemovedMessage
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@NotNull String	getName()	Name of the Custom Field that was removed.
static DeliveryCustomFieldRemovedMessage	of()	factory method
static DeliveryCustomFieldRemovedMessage	of(DeliveryCustomFieldRemovedMessage template)	factory method to create a shallow copy DeliveryCustomFieldRemovedMessage
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<DeliveryCustomFieldRemovedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomFieldRemovedMessage(Function<DeliveryCustomFieldRemovedMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Methods inherited from interface com.commercetools.api.models.message.OrderMessage

withOrderMessage

Field Details

DELIVERY_CUSTOM_FIELD_REMOVED

static final String DELIVERY_CUSTOM_FIELD_REMOVED

discriminator value for DeliveryCustomFieldRemovedMessage

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 DeliveryCustomFieldRemovedMessage of()

factory method

Returns:

instance of DeliveryCustomFieldRemovedMessage

of

static DeliveryCustomFieldRemovedMessage of(DeliveryCustomFieldRemovedMessage template)

factory method to create a shallow copy DeliveryCustomFieldRemovedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryCustomFieldRemovedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static DeliveryCustomFieldRemovedMessage deepCopy(@Nullable
 DeliveryCustomFieldRemovedMessage template)

factory method to create a deep copy of DeliveryCustomFieldRemovedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomFieldRemovedMessageBuilder builder()

builder factory method for DeliveryCustomFieldRemovedMessage

Returns:

builder

builder

static DeliveryCustomFieldRemovedMessageBuilder builder(DeliveryCustomFieldRemovedMessage template)

create builder for DeliveryCustomFieldRemovedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomFieldRemovedMessage

default <T> T withDeliveryCustomFieldRemovedMessage(Function<DeliveryCustomFieldRemovedMessage,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<DeliveryCustomFieldRemovedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference