Package com.commercetools.api.models.customer

Interface CustomerSetAddressCustomFieldAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

public interface CustomerSetAddressCustomFieldAction
extends CustomerUpdateAction

Adding a Custom Field to an Address of a Customer generates the CustomerAddressCustomFieldAdded Message, removing one generates the CustomerAddressCustomFieldRemoved Message, and updating an existing one generates the CustomerAddressCustomFieldChanged Message.

Example to create an instance using the builder pattern

     CustomerSetAddressCustomFieldAction customerSetAddressCustomFieldAction = CustomerSetAddressCustomFieldAction.builder()
             .addressId("{addressId}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_FIELD	discriminator value for CustomerSetAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static CustomerSetAddressCustomFieldActionBuilder	builder()	builder factory method for CustomerSetAddressCustomFieldAction
static CustomerSetAddressCustomFieldActionBuilder	builder(CustomerSetAddressCustomFieldAction template)	create builder for CustomerSetAddressCustomFieldAction instance
CustomerSetAddressCustomFieldAction	copyDeep()
static CustomerSetAddressCustomFieldAction	deepCopy(CustomerSetAddressCustomFieldAction template)	factory method to create a deep copy of CustomerSetAddressCustomFieldAction
@NotNull String	getAddressId()	User-defined unique identifier of the Address to be updated.
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static CustomerSetAddressCustomFieldAction	of()	factory method
static CustomerSetAddressCustomFieldAction	of(CustomerSetAddressCustomFieldAction template)	factory method to create a shallow copy CustomerSetAddressCustomFieldAction
static CustomerSetAddressCustomFieldAction	ofUnset(String name)
void	setAddressId(String addressId)	User-defined unique identifier of the Address to be updated.
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	If value is absent or null, this field will be removed if it exists.
static com.fasterxml.jackson.core.type.TypeReference<CustomerSetAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerSetAddressCustomFieldAction(Function<CustomerSetAddressCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.customer.CustomerUpdateAction

getAction, withCustomerUpdateAction

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

get

Field Details

SET_ADDRESS_CUSTOM_FIELD

static final String SET_ADDRESS_CUSTOM_FIELD

discriminator value for CustomerSetAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

getAddressId

@NotNull
@NotNull String getAddressId()

User-defined unique identifier of the Address to be updated.

Returns:

addressId

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

If value is absent or null, this field will be removed if it exists. If value is provided, it is set for the field defined by name. Trying to remove a field that does not exist will fail with an InvalidOperation error.

Returns:

value

setAddressId

void setAddressId(String addressId)

User-defined unique identifier of the Address to be updated.

Parameters:

addressId - value to be set

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

If value is absent or null, this field will be removed if it exists. If value is provided, it is set for the field defined by name. Trying to remove a field that does not exist will fail with an InvalidOperation error.

Parameters:

value - value to be set

of

static CustomerSetAddressCustomFieldAction of()

factory method

Returns:

instance of CustomerSetAddressCustomFieldAction

of

static CustomerSetAddressCustomFieldAction of(CustomerSetAddressCustomFieldAction template)

factory method to create a shallow copy CustomerSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerSetAddressCustomFieldAction copyDeep()

Specified by:

copyDeep in interface CustomerUpdateAction

deepCopy

@Nullable
static CustomerSetAddressCustomFieldAction deepCopy(@Nullable
 CustomerSetAddressCustomFieldAction template)

factory method to create a deep copy of CustomerSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerSetAddressCustomFieldActionBuilder builder()

builder factory method for CustomerSetAddressCustomFieldAction

Returns:

builder

builder

static CustomerSetAddressCustomFieldActionBuilder builder(CustomerSetAddressCustomFieldAction template)

create builder for CustomerSetAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerSetAddressCustomFieldAction

default <T> T withCustomerSetAddressCustomFieldAction(Function<CustomerSetAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CustomerSetAddressCustomFieldAction ofUnset(String name)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CustomerSetAddressCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference