Package com.commercetools.api.models.message

Interface DeliveryCustomTypeSetMessage

All Superinterfaces:

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

public interface DeliveryCustomTypeSetMessage
extends OrderMessage

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

     DeliveryCustomTypeSetMessage deliveryCustomTypeSetMessage = DeliveryCustomTypeSetMessage.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)
             .customFields(customFieldsBuilder -> customFieldsBuilder)
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomTypeSetMessageBuilder	builder()	builder factory method for DeliveryCustomTypeSetMessage
static DeliveryCustomTypeSetMessageBuilder	builder(DeliveryCustomTypeSetMessage template)	create builder for DeliveryCustomTypeSetMessage instance
DeliveryCustomTypeSetMessage	copyDeep()
static DeliveryCustomTypeSetMessage	deepCopy(DeliveryCustomTypeSetMessage template)	factory method to create a deep copy of DeliveryCustomTypeSetMessage
@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 DeliveryCustomTypeSetMessage	of()	factory method
static DeliveryCustomTypeSetMessage	of(DeliveryCustomTypeSetMessage template)	factory method to create a shallow copy DeliveryCustomTypeSetMessage
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<DeliveryCustomTypeSetMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomTypeSetMessage(Function<DeliveryCustomTypeSetMessage,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_TYPE_SET

static final String DELIVERY_CUSTOM_TYPE_SET

discriminator value for DeliveryCustomTypeSetMessage

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

factory method

Returns:

instance of DeliveryCustomTypeSetMessage

of

static DeliveryCustomTypeSetMessage of(DeliveryCustomTypeSetMessage template)

factory method to create a shallow copy DeliveryCustomTypeSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryCustomTypeSetMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static DeliveryCustomTypeSetMessage deepCopy(@Nullable
 DeliveryCustomTypeSetMessage template)

factory method to create a deep copy of DeliveryCustomTypeSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomTypeSetMessageBuilder builder()

builder factory method for DeliveryCustomTypeSetMessage

Returns:

builder

builder

static DeliveryCustomTypeSetMessageBuilder builder(DeliveryCustomTypeSetMessage template)

create builder for DeliveryCustomTypeSetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomTypeSetMessage

default <T> T withDeliveryCustomTypeSetMessage(Function<DeliveryCustomTypeSetMessage,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<DeliveryCustomTypeSetMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference