Package com.commercetools.api.models.message

Interface BusinessUnitCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface BusinessUnitCustomFieldAddedMessagePayload
extends MessagePayload

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

Example to create an instance using the builder pattern

     BusinessUnitCustomFieldAddedMessagePayload businessUnitCustomFieldAddedMessagePayload = BusinessUnitCustomFieldAddedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUSINESS_UNIT_CUSTOM_FIELD_ADDED	discriminator value for BusinessUnitCustomFieldAddedMessagePayload

Method Summary

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

static final String BUSINESS_UNIT_CUSTOM_FIELD_ADDED

discriminator value for BusinessUnitCustomFieldAddedMessagePayload

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

factory method

Returns:

instance of BusinessUnitCustomFieldAddedMessagePayload

of

static BusinessUnitCustomFieldAddedMessagePayload of(BusinessUnitCustomFieldAddedMessagePayload template)

factory method to create a shallow copy BusinessUnitCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitCustomFieldAddedMessagePayload deepCopy(@Nullable
 BusinessUnitCustomFieldAddedMessagePayload template)

factory method to create a deep copy of BusinessUnitCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for BusinessUnitCustomFieldAddedMessagePayload

Returns:

builder

builder

static BusinessUnitCustomFieldAddedMessagePayloadBuilder builder(BusinessUnitCustomFieldAddedMessagePayload template)

create builder for BusinessUnitCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitCustomFieldAddedMessagePayload

default <T> T withBusinessUnitCustomFieldAddedMessagePayload(Function<BusinessUnitCustomFieldAddedMessagePayload,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<BusinessUnitCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference