Interface DeliveryCustomFieldChangedMessagePayload
- All Superinterfaces:
MessagePayload
,MessagePayloadMixin
,OrderMessagePayload
Generated when an existing Custom Field on a Delivery has been changed using the Set CustomField update action.
Example to create an instance using the builder pattern
DeliveryCustomFieldChangedMessagePayload deliveryCustomFieldChangedMessagePayload = DeliveryCustomFieldChangedMessagePayload.builder()
.name("{name}")
.deliveryId("{deliveryId}")
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for DeliveryCustomFieldChangedMessagePayload -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for DeliveryCustomFieldChangedMessagePayloadcreate builder for DeliveryCustomFieldChangedMessagePayload instancecopyDeep()
factory method to create a deep copy of DeliveryCustomFieldChangedMessagePayload@NotNull String
Unique identifier of the Delivery.@NotNull String
getName()
Name of the Custom Field that changed.@NotNull Object
getValue()
of()
factory methodof
(DeliveryCustomFieldChangedMessagePayload template) factory method to create a shallow copy DeliveryCustomFieldChangedMessagePayloadvoid
setDeliveryId
(String deliveryId) Unique identifier of the Delivery.void
Name of the Custom Field that changed.void
setPreviousValue
(Object previousValue) void
static com.fasterxml.jackson.core.type.TypeReference<DeliveryCustomFieldChangedMessagePayload>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withDeliveryCustomFieldChangedMessagePayload
(Function<DeliveryCustomFieldChangedMessagePayload, T> helper) accessor map functionMethods 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_CHANGED
discriminator value for DeliveryCustomFieldChangedMessagePayload- See Also:
-
-
Method Details
-
getName
Name of the Custom Field that changed.
- Returns:
- name
-
getValue
CustomFieldValue based on the FieldType after the Set CustomField update action.
- Returns:
- value
-
getPreviousValue
Object getPreviousValue()CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the
name
on the Delivery before, a Delivery Custom Field Added Message is generated instead.- Returns:
- previousValue
-
getDeliveryId
Unique identifier of the Delivery.
- Returns:
- deliveryId
-
setName
Name of the Custom Field that changed.
- Parameters:
name
- value to be set
-
setValue
CustomFieldValue based on the FieldType after the Set CustomField update action.
- Parameters:
value
- value to be set
-
setPreviousValue
CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the
name
on the Delivery before, a Delivery Custom Field Added Message is generated instead.- Parameters:
previousValue
- value to be set
-
setDeliveryId
Unique identifier of the Delivery.
- Parameters:
deliveryId
- value to be set
-
of
factory method- Returns:
- instance of DeliveryCustomFieldChangedMessagePayload
-
of
static DeliveryCustomFieldChangedMessagePayload of(DeliveryCustomFieldChangedMessagePayload template) factory method to create a shallow copy DeliveryCustomFieldChangedMessagePayload- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
copyDeep
DeliveryCustomFieldChangedMessagePayload copyDeep()- Specified by:
copyDeep
in interfaceMessagePayload
- Specified by:
copyDeep
in interfaceOrderMessagePayload
-
deepCopy
@Nullable static DeliveryCustomFieldChangedMessagePayload deepCopy(@Nullable DeliveryCustomFieldChangedMessagePayload template) factory method to create a deep copy of DeliveryCustomFieldChangedMessagePayload- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for DeliveryCustomFieldChangedMessagePayload- Returns:
- builder
-
builder
static DeliveryCustomFieldChangedMessagePayloadBuilder builder(DeliveryCustomFieldChangedMessagePayload template) create builder for DeliveryCustomFieldChangedMessagePayload instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withDeliveryCustomFieldChangedMessagePayload
default <T> T withDeliveryCustomFieldChangedMessagePayload(Function<DeliveryCustomFieldChangedMessagePayload, 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<DeliveryCustomFieldChangedMessagePayload> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-