Package com.commercetools.api.models.message

Interface CustomerAddressCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface CustomerAddressCustomFieldAddedMessagePayload
extends MessagePayload

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

Example to create an instance using the builder pattern

     CustomerAddressCustomFieldAddedMessagePayload customerAddressCustomFieldAddedMessagePayload = CustomerAddressCustomFieldAddedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_ADDRESS_CUSTOM_FIELD_ADDED	discriminator value for CustomerAddressCustomFieldAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static CustomerAddressCustomFieldAddedMessagePayloadBuilder	builder()	builder factory method for CustomerAddressCustomFieldAddedMessagePayload
static CustomerAddressCustomFieldAddedMessagePayloadBuilder	builder(CustomerAddressCustomFieldAddedMessagePayload template)	create builder for CustomerAddressCustomFieldAddedMessagePayload instance
static CustomerAddressCustomFieldAddedMessagePayload	deepCopy(CustomerAddressCustomFieldAddedMessagePayload template)	factory method to create a deep copy of CustomerAddressCustomFieldAddedMessagePayload
@NotNull String	getName()	Name of the Custom Field that was added.
@NotNull Object	getValue()	The added CustomFieldValue based on the FieldType.
static CustomerAddressCustomFieldAddedMessagePayload	of()	factory method
static CustomerAddressCustomFieldAddedMessagePayload	of(CustomerAddressCustomFieldAddedMessagePayload template)	factory method to create a shallow copy CustomerAddressCustomFieldAddedMessagePayload
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<CustomerAddressCustomFieldAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerAddressCustomFieldAddedMessagePayload(Function<CustomerAddressCustomFieldAddedMessagePayload,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_ADDRESS_CUSTOM_FIELD_ADDED

static final String CUSTOMER_ADDRESS_CUSTOM_FIELD_ADDED

discriminator value for CustomerAddressCustomFieldAddedMessagePayload

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

factory method

Returns:

instance of CustomerAddressCustomFieldAddedMessagePayload

of

static CustomerAddressCustomFieldAddedMessagePayload of(CustomerAddressCustomFieldAddedMessagePayload template)

factory method to create a shallow copy CustomerAddressCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomerAddressCustomFieldAddedMessagePayload deepCopy(@Nullable
 CustomerAddressCustomFieldAddedMessagePayload template)

factory method to create a deep copy of CustomerAddressCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerAddressCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for CustomerAddressCustomFieldAddedMessagePayload

Returns:

builder

builder

static CustomerAddressCustomFieldAddedMessagePayloadBuilder builder(CustomerAddressCustomFieldAddedMessagePayload template)

create builder for CustomerAddressCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerAddressCustomFieldAddedMessagePayload

default <T> T withCustomerAddressCustomFieldAddedMessagePayload(Function<CustomerAddressCustomFieldAddedMessagePayload,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<CustomerAddressCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference