Package com.commercetools.api.models.message

Interface BusinessUnitAddressCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

All Known Implementing Classes:

BusinessUnitAddressCustomFieldAddedMessagePayloadImpl

public interface BusinessUnitAddressCustomFieldAddedMessagePayload
extends MessagePayload

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

Example to create an instance using the builder pattern

     BusinessUnitAddressCustomFieldAddedMessagePayload businessUnitAddressCustomFieldAddedMessagePayload = BusinessUnitAddressCustomFieldAddedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUSINESS_UNIT_ADDRESS_CUSTOM_FIELD_ADDED	discriminator value for BusinessUnitAddressCustomFieldAddedMessagePayload

Method Summary

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

BUSINESS_UNIT_ADDRESS_CUSTOM_FIELD_ADDED

static final String BUSINESS_UNIT_ADDRESS_CUSTOM_FIELD_ADDED

discriminator value for BusinessUnitAddressCustomFieldAddedMessagePayload

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

factory method

Returns:

instance of BusinessUnitAddressCustomFieldAddedMessagePayload

of

static BusinessUnitAddressCustomFieldAddedMessagePayload of(BusinessUnitAddressCustomFieldAddedMessagePayload template)

factory method to create a shallow copy BusinessUnitAddressCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitAddressCustomFieldAddedMessagePayload deepCopy(@Nullable
 BusinessUnitAddressCustomFieldAddedMessagePayload template)

factory method to create a deep copy of BusinessUnitAddressCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitAddressCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for BusinessUnitAddressCustomFieldAddedMessagePayload

Returns:

builder

builder

static BusinessUnitAddressCustomFieldAddedMessagePayloadBuilder builder(BusinessUnitAddressCustomFieldAddedMessagePayload template)

create builder for BusinessUnitAddressCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitAddressCustomFieldAddedMessagePayload

default <T> T withBusinessUnitAddressCustomFieldAddedMessagePayload(Function<BusinessUnitAddressCustomFieldAddedMessagePayload,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<BusinessUnitAddressCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference