Package com.commercetools.api.models.message

Interface CustomerAddressCustomFieldRemovedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface CustomerAddressCustomFieldRemovedMessagePayload
extends MessagePayload

Generated after removing a Custom Field from an Address of a Customer using the Set CustomField in Address update action.

Example to create an instance using the builder pattern

     CustomerAddressCustomFieldRemovedMessagePayload customerAddressCustomFieldRemovedMessagePayload = CustomerAddressCustomFieldRemovedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_ADDRESS_CUSTOM_FIELD_REMOVED	discriminator value for CustomerAddressCustomFieldRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static CustomerAddressCustomFieldRemovedMessagePayloadBuilder	builder()	builder factory method for CustomerAddressCustomFieldRemovedMessagePayload
static CustomerAddressCustomFieldRemovedMessagePayloadBuilder	builder(CustomerAddressCustomFieldRemovedMessagePayload template)	create builder for CustomerAddressCustomFieldRemovedMessagePayload instance
static CustomerAddressCustomFieldRemovedMessagePayload	deepCopy(CustomerAddressCustomFieldRemovedMessagePayload template)	factory method to create a deep copy of CustomerAddressCustomFieldRemovedMessagePayload
String	getAddressId()	id of the Address from which the Custom Field was removed.
@NotNull String	getName()	Name of the Custom Field that was removed.
static CustomerAddressCustomFieldRemovedMessagePayload	of()	factory method
static CustomerAddressCustomFieldRemovedMessagePayload	of(CustomerAddressCustomFieldRemovedMessagePayload template)	factory method to create a shallow copy CustomerAddressCustomFieldRemovedMessagePayload
void	setAddressId(String addressId)	id of the Address from which the Custom Field was removed.
void	setName(String name)	Name of the Custom Field that was removed.
static com.fasterxml.jackson.core.type.TypeReference<CustomerAddressCustomFieldRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerAddressCustomFieldRemovedMessagePayload(Function<CustomerAddressCustomFieldRemovedMessagePayload,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_FIELD_REMOVED

static final String CUSTOMER_ADDRESS_CUSTOM_FIELD_REMOVED

discriminator value for CustomerAddressCustomFieldRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that was removed.

Returns:

name

getAddressId

String getAddressId()

id of the Address from which the Custom Field was removed.

Returns:

addressId

setName

void setName(String name)

Name of the Custom Field that was removed.

Parameters:

name - value to be set

setAddressId

void setAddressId(String addressId)

id of the Address from which the Custom Field was removed.

Parameters:

addressId - value to be set

of

static CustomerAddressCustomFieldRemovedMessagePayload of()

factory method

Returns:

instance of CustomerAddressCustomFieldRemovedMessagePayload

of

static CustomerAddressCustomFieldRemovedMessagePayload of(CustomerAddressCustomFieldRemovedMessagePayload template)

factory method to create a shallow copy CustomerAddressCustomFieldRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomerAddressCustomFieldRemovedMessagePayload deepCopy(@Nullable
 CustomerAddressCustomFieldRemovedMessagePayload template)

factory method to create a deep copy of CustomerAddressCustomFieldRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerAddressCustomFieldRemovedMessagePayloadBuilder builder()

builder factory method for CustomerAddressCustomFieldRemovedMessagePayload

Returns:

builder

builder

static CustomerAddressCustomFieldRemovedMessagePayloadBuilder builder(CustomerAddressCustomFieldRemovedMessagePayload template)

create builder for CustomerAddressCustomFieldRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerAddressCustomFieldRemovedMessagePayload

default <T> T withCustomerAddressCustomFieldRemovedMessagePayload(Function<CustomerAddressCustomFieldRemovedMessagePayload,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<CustomerAddressCustomFieldRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference