Package com.commercetools.api.models.message

Interface CustomerCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface CustomerCustomFieldAddedMessagePayload
extends MessagePayload

Generated after adding a Custom Field to a Customer using the Set CustomField update action. If a Custom Field already exists with the same name, a CustomerCustomFieldChanged Message is generated instead.

Example to create an instance using the builder pattern

     CustomerCustomFieldAddedMessagePayload customerCustomFieldAddedMessagePayload = CustomerCustomFieldAddedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_CUSTOM_FIELD_ADDED	discriminator value for CustomerCustomFieldAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static CustomerCustomFieldAddedMessagePayloadBuilder	builder()	builder factory method for CustomerCustomFieldAddedMessagePayload
static CustomerCustomFieldAddedMessagePayloadBuilder	builder(CustomerCustomFieldAddedMessagePayload template)	create builder for CustomerCustomFieldAddedMessagePayload instance
static CustomerCustomFieldAddedMessagePayload	deepCopy(CustomerCustomFieldAddedMessagePayload template)	factory method to create a deep copy of CustomerCustomFieldAddedMessagePayload
@NotNull String	getName()	Name of the Custom Field that was added.
@NotNull Object	getValue()	The added CustomFieldValue based on the FieldType.
static CustomerCustomFieldAddedMessagePayload	of()	factory method
static CustomerCustomFieldAddedMessagePayload	of(CustomerCustomFieldAddedMessagePayload template)	factory method to create a shallow copy CustomerCustomFieldAddedMessagePayload
void	setName(String name)	Name of the Custom Field that was added.
void	setValue(Object value)	The added CustomFieldValue based on the FieldType.
static com.fasterxml.jackson.core.type.TypeReference<CustomerCustomFieldAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerCustomFieldAddedMessagePayload(Function<CustomerCustomFieldAddedMessagePayload,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_ADDED

static final String CUSTOMER_CUSTOM_FIELD_ADDED

discriminator value for CustomerCustomFieldAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that was added.

Returns:

name

getValue

@NotNull
@NotNull Object getValue()

The added CustomFieldValue based on the FieldType.

Returns:

value

setName

void setName(String name)

Name of the Custom Field that was added.

Parameters:

name - value to be set

setValue

void setValue(Object value)

The added CustomFieldValue based on the FieldType.

Parameters:

value - value to be set

of

static CustomerCustomFieldAddedMessagePayload of()

factory method

Returns:

instance of CustomerCustomFieldAddedMessagePayload

of

static CustomerCustomFieldAddedMessagePayload of(CustomerCustomFieldAddedMessagePayload template)

factory method to create a shallow copy CustomerCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomerCustomFieldAddedMessagePayload deepCopy(@Nullable
 CustomerCustomFieldAddedMessagePayload template)

factory method to create a deep copy of CustomerCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for CustomerCustomFieldAddedMessagePayload

Returns:

builder

builder

static CustomerCustomFieldAddedMessagePayloadBuilder builder(CustomerCustomFieldAddedMessagePayload template)

create builder for CustomerCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerCustomFieldAddedMessagePayload

default <T> T withCustomerCustomFieldAddedMessagePayload(Function<CustomerCustomFieldAddedMessagePayload,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<CustomerCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference