Package com.commercetools.api.models.message

Interface CustomerCustomFieldChangedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface CustomerCustomFieldChangedMessagePayload
extends MessagePayload

Generated after changing an existing Custom Field on a Customer using the Set CustomField update action.

Example to create an instance using the builder pattern

     CustomerCustomFieldChangedMessagePayload customerCustomFieldChangedMessagePayload = CustomerCustomFieldChangedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_CUSTOM_FIELD_CHANGED	discriminator value for CustomerCustomFieldChangedMessagePayload

Method Summary

Modifier and Type	Method	Description
static CustomerCustomFieldChangedMessagePayloadBuilder	builder()	builder factory method for CustomerCustomFieldChangedMessagePayload
static CustomerCustomFieldChangedMessagePayloadBuilder	builder(CustomerCustomFieldChangedMessagePayload template)	create builder for CustomerCustomFieldChangedMessagePayload instance
CustomerCustomFieldChangedMessagePayload	copyDeep()
static CustomerCustomFieldChangedMessagePayload	deepCopy(CustomerCustomFieldChangedMessagePayload template)	factory method to create a deep copy of CustomerCustomFieldChangedMessagePayload
@NotNull String	getName()	Name of the Custom Field that changed.
Object	getPreviousValue()	CustomFieldValue based on the FieldType before the Set CustomField update action.
@NotNull Object	getValue()	CustomFieldValue based on the FieldType after the Set CustomField update action.
static CustomerCustomFieldChangedMessagePayload	of()	factory method
static CustomerCustomFieldChangedMessagePayload	of(CustomerCustomFieldChangedMessagePayload template)	factory method to create a shallow copy CustomerCustomFieldChangedMessagePayload
void	setName(String name)	Name of the Custom Field that changed.
void	setPreviousValue(Object previousValue)	CustomFieldValue based on the FieldType before the Set CustomField update action.
void	setValue(Object value)	CustomFieldValue based on the FieldType after the Set CustomField update action.
static com.fasterxml.jackson.core.type.TypeReference<CustomerCustomFieldChangedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerCustomFieldChangedMessagePayload(Function<CustomerCustomFieldChangedMessagePayload,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

Field Details

CUSTOMER_CUSTOM_FIELD_CHANGED

static final String CUSTOMER_CUSTOM_FIELD_CHANGED

discriminator value for CustomerCustomFieldChangedMessagePayload

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that changed.

Returns:

name

getValue

@NotNull
@NotNull Object 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 before, a Customer Custom Field Added Message is generated instead.

Returns:

previousValue

setName

void setName(String name)

Name of the Custom Field that changed.

Parameters:

name - value to be set

setValue

void setValue(Object value)

CustomFieldValue based on the FieldType after the Set CustomField update action.

Parameters:

value - value to be set

setPreviousValue

void setPreviousValue(Object previousValue)

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 before, a Customer Custom Field Added Message is generated instead.

Parameters:

previousValue - value to be set

of

static CustomerCustomFieldChangedMessagePayload of()

factory method

Returns:

instance of CustomerCustomFieldChangedMessagePayload

of

static CustomerCustomFieldChangedMessagePayload of(CustomerCustomFieldChangedMessagePayload template)

factory method to create a shallow copy CustomerCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerCustomFieldChangedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static CustomerCustomFieldChangedMessagePayload deepCopy(@Nullable
 CustomerCustomFieldChangedMessagePayload template)

factory method to create a deep copy of CustomerCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerCustomFieldChangedMessagePayloadBuilder builder()

builder factory method for CustomerCustomFieldChangedMessagePayload

Returns:

builder

builder

static CustomerCustomFieldChangedMessagePayloadBuilder builder(CustomerCustomFieldChangedMessagePayload template)

create builder for CustomerCustomFieldChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerCustomFieldChangedMessagePayload

default <T> T withCustomerCustomFieldChangedMessagePayload(Function<CustomerCustomFieldChangedMessagePayload,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<CustomerCustomFieldChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference