Package com.commercetools.api.models.message

Interface BusinessUnitAddressCustomFieldAddedMessage

All Superinterfaces:

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

public interface BusinessUnitAddressCustomFieldAddedMessage
extends Message

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

     BusinessUnitAddressCustomFieldAddedMessage businessUnitAddressCustomFieldAddedMessage = BusinessUnitAddressCustomFieldAddedMessage.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_ADDRESS_CUSTOM_FIELD_ADDED	discriminator value for BusinessUnitAddressCustomFieldAddedMessage

Method Summary

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

static final String BUSINESS_UNIT_ADDRESS_CUSTOM_FIELD_ADDED

discriminator value for BusinessUnitAddressCustomFieldAddedMessage

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

getAddressId

String getAddressId()

id of the Address to which the Custom Field was added.

Returns:

addressId

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

setAddressId

void setAddressId(String addressId)

id of the Address to which the Custom Field was added.

Parameters:

addressId - value to be set

of

static BusinessUnitAddressCustomFieldAddedMessage of()

factory method

Returns:

instance of BusinessUnitAddressCustomFieldAddedMessage

of

static BusinessUnitAddressCustomFieldAddedMessage of(BusinessUnitAddressCustomFieldAddedMessage template)

factory method to create a shallow copy BusinessUnitAddressCustomFieldAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitAddressCustomFieldAddedMessage deepCopy(@Nullable
 BusinessUnitAddressCustomFieldAddedMessage template)

factory method to create a deep copy of BusinessUnitAddressCustomFieldAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitAddressCustomFieldAddedMessageBuilder builder()

builder factory method for BusinessUnitAddressCustomFieldAddedMessage

Returns:

builder

builder

static BusinessUnitAddressCustomFieldAddedMessageBuilder builder(BusinessUnitAddressCustomFieldAddedMessage template)

create builder for BusinessUnitAddressCustomFieldAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitAddressCustomFieldAddedMessage

default <T> T withBusinessUnitAddressCustomFieldAddedMessage(Function<BusinessUnitAddressCustomFieldAddedMessage,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<BusinessUnitAddressCustomFieldAddedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference