Package com.commercetools.api.models.message

Interface BusinessUnitAddressCustomTypeSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface BusinessUnitAddressCustomTypeSetMessagePayload
extends MessagePayload

Generated after adding a Custom Type to an address of a Business Unit using the Set Custom Type in Address update action.

Example to create an instance using the builder pattern

     BusinessUnitAddressCustomTypeSetMessagePayload businessUnitAddressCustomTypeSetMessagePayload = BusinessUnitAddressCustomTypeSetMessagePayload.builder()
             .customFields(customFieldsBuilder -> customFieldsBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUSINESS_UNIT_ADDRESS_CUSTOM_TYPE_SET	discriminator value for BusinessUnitAddressCustomTypeSetMessagePayload

Method Summary

Modifier and Type	Method	Description
static BusinessUnitAddressCustomTypeSetMessagePayloadBuilder	builder()	builder factory method for BusinessUnitAddressCustomTypeSetMessagePayload
static BusinessUnitAddressCustomTypeSetMessagePayloadBuilder	builder(BusinessUnitAddressCustomTypeSetMessagePayload template)	create builder for BusinessUnitAddressCustomTypeSetMessagePayload instance
BusinessUnitAddressCustomTypeSetMessagePayload	copyDeep()
static BusinessUnitAddressCustomTypeSetMessagePayload	deepCopy(BusinessUnitAddressCustomTypeSetMessagePayload template)	factory method to create a deep copy of BusinessUnitAddressCustomTypeSetMessagePayload
String	getAddressId()	id of the Address on which the Custom Field was set.
@NotNull @Valid CustomFields	getCustomFields()	The Custom Fields that were set.
String	getOldTypeId()	id of the previous Custom Type.
static BusinessUnitAddressCustomTypeSetMessagePayload	of()	factory method
static BusinessUnitAddressCustomTypeSetMessagePayload	of(BusinessUnitAddressCustomTypeSetMessagePayload template)	factory method to create a shallow copy BusinessUnitAddressCustomTypeSetMessagePayload
void	setAddressId(String addressId)	id of the Address on which the Custom Field was set.
void	setCustomFields(CustomFields customFields)	The Custom Fields that were set.
void	setOldTypeId(String oldTypeId)	id of the previous Custom Type.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitAddressCustomTypeSetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitAddressCustomTypeSetMessagePayload(Function<BusinessUnitAddressCustomTypeSetMessagePayload,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_TYPE_SET

static final String BUSINESS_UNIT_ADDRESS_CUSTOM_TYPE_SET

discriminator value for BusinessUnitAddressCustomTypeSetMessagePayload

See Also:

• Constant Field Values

Method Details

getCustomFields

@NotNull
@Valid
@NotNull @Valid CustomFields getCustomFields()

The Custom Fields that were set.

Returns:

customFields

getOldTypeId

String getOldTypeId()

id of the previous Custom Type. Absent if there was no previous Custom Type present.

Returns:

oldTypeId

getAddressId

String getAddressId()

id of the Address on which the Custom Field was set.

Returns:

addressId

setCustomFields

void setCustomFields(CustomFields customFields)

The Custom Fields that were set.

Parameters:

customFields - value to be set

setOldTypeId

void setOldTypeId(String oldTypeId)

id of the previous Custom Type. Absent if there was no previous Custom Type present.

Parameters:

oldTypeId - value to be set

setAddressId

void setAddressId(String addressId)

id of the Address on which the Custom Field was set.

Parameters:

addressId - value to be set

of

static BusinessUnitAddressCustomTypeSetMessagePayload of()

factory method

Returns:

instance of BusinessUnitAddressCustomTypeSetMessagePayload

of

static BusinessUnitAddressCustomTypeSetMessagePayload of(BusinessUnitAddressCustomTypeSetMessagePayload template)

factory method to create a shallow copy BusinessUnitAddressCustomTypeSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

BusinessUnitAddressCustomTypeSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static BusinessUnitAddressCustomTypeSetMessagePayload deepCopy(@Nullable
 BusinessUnitAddressCustomTypeSetMessagePayload template)

factory method to create a deep copy of BusinessUnitAddressCustomTypeSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitAddressCustomTypeSetMessagePayloadBuilder builder()

builder factory method for BusinessUnitAddressCustomTypeSetMessagePayload

Returns:

builder

builder

static BusinessUnitAddressCustomTypeSetMessagePayloadBuilder builder(BusinessUnitAddressCustomTypeSetMessagePayload template)

create builder for BusinessUnitAddressCustomTypeSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitAddressCustomTypeSetMessagePayload

default <T> T withBusinessUnitAddressCustomTypeSetMessagePayload(Function<BusinessUnitAddressCustomTypeSetMessagePayload,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<BusinessUnitAddressCustomTypeSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference