Interface CustomerAddressCustomFieldChangedMessagePayload
- All Superinterfaces:
MessagePayload
,MessagePayloadMixin
Generated after changing an existing Custom Field on an Address of a Customer using the Set CustomField in Address update action.
Example to create an instance using the builder pattern
CustomerAddressCustomFieldChangedMessagePayload customerAddressCustomFieldChangedMessagePayload = CustomerAddressCustomFieldChangedMessagePayload.builder()
.name("{name}")
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for CustomerAddressCustomFieldChangedMessagePayload -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for CustomerAddressCustomFieldChangedMessagePayloadcreate builder for CustomerAddressCustomFieldChangedMessagePayload instancecopyDeep()
factory method to create a deep copy of CustomerAddressCustomFieldChangedMessagePayloadid
of the Address of which the Custom Field was changed.@NotNull String
getName()
Name of the Custom Field that changed.@NotNull Object
getValue()
of()
factory methodfactory method to create a shallow copy CustomerAddressCustomFieldChangedMessagePayloadvoid
setAddressId
(String addressId) id
of the Address of which the Custom Field was changed.void
Name of the Custom Field that changed.void
setPreviousValue
(Object previousValue) void
static com.fasterxml.jackson.core.type.TypeReference<CustomerAddressCustomFieldChangedMessagePayload>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withCustomerAddressCustomFieldChangedMessagePayload
(Function<CustomerAddressCustomFieldChangedMessagePayload, 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
-
Field Details
-
CUSTOMER_ADDRESS_CUSTOM_FIELD_CHANGED
discriminator value for CustomerAddressCustomFieldChangedMessagePayload- 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 Customer Address before, a Customer Address Custom Field Added Message is generated instead.- Returns:
- previousValue
-
getAddressId
String getAddressId()id
of the Address of which the Custom Field was changed.- Returns:
- addressId
-
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 Customer Address before, a Customer Address Custom Field Added Message is generated instead.- Parameters:
previousValue
- value to be set
-
setAddressId
id
of the Address of which the Custom Field was changed.- Parameters:
addressId
- value to be set
-
of
factory method- Returns:
- instance of CustomerAddressCustomFieldChangedMessagePayload
-
of
static CustomerAddressCustomFieldChangedMessagePayload of(CustomerAddressCustomFieldChangedMessagePayload template) factory method to create a shallow copy CustomerAddressCustomFieldChangedMessagePayload- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
copyDeep
- Specified by:
copyDeep
in interfaceMessagePayload
-
deepCopy
@Nullable static CustomerAddressCustomFieldChangedMessagePayload deepCopy(@Nullable CustomerAddressCustomFieldChangedMessagePayload template) factory method to create a deep copy of CustomerAddressCustomFieldChangedMessagePayload- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for CustomerAddressCustomFieldChangedMessagePayload- Returns:
- builder
-
builder
static CustomerAddressCustomFieldChangedMessagePayloadBuilder builder(CustomerAddressCustomFieldChangedMessagePayload template) create builder for CustomerAddressCustomFieldChangedMessagePayload instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withCustomerAddressCustomFieldChangedMessagePayload
default <T> T withCustomerAddressCustomFieldChangedMessagePayload(Function<CustomerAddressCustomFieldChangedMessagePayload, 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<CustomerAddressCustomFieldChangedMessagePayload> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-