Package com.commercetools.api.models.customer

Interface CustomerSetCustomFieldAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

All Known Implementing Classes:

CustomerSetCustomFieldActionImpl

public interface CustomerSetCustomFieldAction
extends CustomerUpdateAction

CustomerSetCustomFieldAction Example to create an instance using the builder pattern

     CustomerSetCustomFieldAction customerSetCustomFieldAction = CustomerSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_FIELD	discriminator value for CustomerSetCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static CustomerSetCustomFieldActionBuilder	builder()	builder factory method for CustomerSetCustomFieldAction
static CustomerSetCustomFieldActionBuilder	builder(CustomerSetCustomFieldAction template)	create builder for CustomerSetCustomFieldAction instance
static CustomerSetCustomFieldAction	deepCopy(CustomerSetCustomFieldAction template)	factory method to create a deep copy of CustomerSetCustomFieldAction
@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 CustomerSetCustomFieldAction	of()	factory method
static CustomerSetCustomFieldAction	of(CustomerSetCustomFieldAction template)	factory method to create a shallow copy CustomerSetCustomFieldAction
static CustomerSetCustomFieldAction	ofUnset(String name)
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<CustomerSetCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerSetCustomFieldAction(Function<CustomerSetCustomFieldAction,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_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for CustomerSetCustomFieldAction

See Also:

• Constant Field Values

Method Details

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

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 CustomerSetCustomFieldAction of()

factory method

Returns:

instance of CustomerSetCustomFieldAction

of

static CustomerSetCustomFieldAction of(CustomerSetCustomFieldAction template)

factory method to create a shallow copy CustomerSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomerSetCustomFieldAction deepCopy(@Nullable
 CustomerSetCustomFieldAction template)

factory method to create a deep copy of CustomerSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerSetCustomFieldActionBuilder builder()

builder factory method for CustomerSetCustomFieldAction

Returns:

builder

builder

static CustomerSetCustomFieldActionBuilder builder(CustomerSetCustomFieldAction template)

create builder for CustomerSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerSetCustomFieldAction

default <T> T withCustomerSetCustomFieldAction(Function<CustomerSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CustomerSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference