Package com.commercetools.api.models.message

Interface BusinessUnitCustomFieldAddedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface BusinessUnitCustomFieldAddedMessage
extends Message

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

     BusinessUnitCustomFieldAddedMessage businessUnitCustomFieldAddedMessage = BusinessUnitCustomFieldAddedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

BUSINESS_UNIT_CUSTOM_FIELD_ADDED

static final String BUSINESS_UNIT_CUSTOM_FIELD_ADDED

discriminator value for BusinessUnitCustomFieldAddedMessage

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

factory method

Returns:

instance of BusinessUnitCustomFieldAddedMessage

of

static BusinessUnitCustomFieldAddedMessage of(BusinessUnitCustomFieldAddedMessage template)

factory method to create a shallow copy BusinessUnitCustomFieldAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitCustomFieldAddedMessage deepCopy(@Nullable
 BusinessUnitCustomFieldAddedMessage template)

factory method to create a deep copy of BusinessUnitCustomFieldAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitCustomFieldAddedMessageBuilder builder()

builder factory method for BusinessUnitCustomFieldAddedMessage

Returns:

builder

builder

static BusinessUnitCustomFieldAddedMessageBuilder builder(BusinessUnitCustomFieldAddedMessage template)

create builder for BusinessUnitCustomFieldAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitCustomFieldAddedMessage

default <T> T withBusinessUnitCustomFieldAddedMessage(Function<BusinessUnitCustomFieldAddedMessage,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<BusinessUnitCustomFieldAddedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference