Package com.commercetools.api.models.message

Interface CustomerAddressCustomTypeSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface CustomerAddressCustomTypeSetMessagePayload
extends MessagePayload

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

Example to create an instance using the builder pattern

     CustomerAddressCustomTypeSetMessagePayload customerAddressCustomTypeSetMessagePayload = CustomerAddressCustomTypeSetMessagePayload.builder()
             .customFields(customFieldsBuilder -> customFieldsBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_ADDRESS_CUSTOM_TYPE_SET	discriminator value for CustomerAddressCustomTypeSetMessagePayload

Method Summary

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

CUSTOMER_ADDRESS_CUSTOM_TYPE_SET

static final String CUSTOMER_ADDRESS_CUSTOM_TYPE_SET

discriminator value for CustomerAddressCustomTypeSetMessagePayload

See Also:

• Constant Field Values

Method Details

getCustomFields

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

The Custom Fields that have been set.

Returns:

customFields

getPreviousTypeId

String getPreviousTypeId()

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

Returns:

previousTypeId

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 have been set.

Parameters:

customFields - value to be set

setPreviousTypeId

void setPreviousTypeId(String previousTypeId)

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

Parameters:

previousTypeId - 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 CustomerAddressCustomTypeSetMessagePayload of()

factory method

Returns:

instance of CustomerAddressCustomTypeSetMessagePayload

of

static CustomerAddressCustomTypeSetMessagePayload of(CustomerAddressCustomTypeSetMessagePayload template)

factory method to create a shallow copy CustomerAddressCustomTypeSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerAddressCustomTypeSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static CustomerAddressCustomTypeSetMessagePayload deepCopy(@Nullable
 CustomerAddressCustomTypeSetMessagePayload template)

factory method to create a deep copy of CustomerAddressCustomTypeSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerAddressCustomTypeSetMessagePayloadBuilder builder()

builder factory method for CustomerAddressCustomTypeSetMessagePayload

Returns:

builder

builder

static CustomerAddressCustomTypeSetMessagePayloadBuilder builder(CustomerAddressCustomTypeSetMessagePayload template)

create builder for CustomerAddressCustomTypeSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerAddressCustomTypeSetMessagePayload

default <T> T withCustomerAddressCustomTypeSetMessagePayload(Function<CustomerAddressCustomTypeSetMessagePayload,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<CustomerAddressCustomTypeSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference