Package com.commercetools.api.models.me

Interface MyBusinessUnitSetCustomFieldAction

All Superinterfaces:

MyBusinessUnitUpdateAction

public interface MyBusinessUnitSetCustomFieldAction
extends MyBusinessUnitUpdateAction

Adding a Custom Field to a Business Unit generates the BusinessUnitCustomFieldAdded Message, removing one generates the BusinessUnitCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitCustomFieldChanged Message.

Example to create an instance using the builder pattern

     MyBusinessUnitSetCustomFieldAction myBusinessUnitSetCustomFieldAction = MyBusinessUnitSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyBusinessUnitSetCustomFieldActionBuilder	builder()	builder factory method for MyBusinessUnitSetCustomFieldAction
static MyBusinessUnitSetCustomFieldActionBuilder	builder(MyBusinessUnitSetCustomFieldAction template)	create builder for MyBusinessUnitSetCustomFieldAction instance
MyBusinessUnitSetCustomFieldAction	copyDeep()
static MyBusinessUnitSetCustomFieldAction	deepCopy(MyBusinessUnitSetCustomFieldAction template)	factory method to create a deep copy of MyBusinessUnitSetCustomFieldAction
@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 MyBusinessUnitSetCustomFieldAction	of()	factory method
static MyBusinessUnitSetCustomFieldAction	of(MyBusinessUnitSetCustomFieldAction template)	factory method to create a shallow copy MyBusinessUnitSetCustomFieldAction
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<MyBusinessUnitSetCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyBusinessUnitSetCustomFieldAction(Function<MyBusinessUnitSetCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyBusinessUnitUpdateAction

getAction, withMyBusinessUnitUpdateAction

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for MyBusinessUnitSetCustomFieldAction

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. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

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. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static MyBusinessUnitSetCustomFieldAction of()

factory method

Returns:

instance of MyBusinessUnitSetCustomFieldAction

of

static MyBusinessUnitSetCustomFieldAction of(MyBusinessUnitSetCustomFieldAction template)

factory method to create a shallow copy MyBusinessUnitSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyBusinessUnitSetCustomFieldAction copyDeep()

Specified by:

copyDeep in interface MyBusinessUnitUpdateAction

deepCopy

@Nullable
static MyBusinessUnitSetCustomFieldAction deepCopy(@Nullable
 MyBusinessUnitSetCustomFieldAction template)

factory method to create a deep copy of MyBusinessUnitSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyBusinessUnitSetCustomFieldActionBuilder builder()

builder factory method for MyBusinessUnitSetCustomFieldAction

Returns:

builder

builder

static MyBusinessUnitSetCustomFieldActionBuilder builder(MyBusinessUnitSetCustomFieldAction template)

create builder for MyBusinessUnitSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyBusinessUnitSetCustomFieldAction

default <T> T withMyBusinessUnitSetCustomFieldAction(Function<MyBusinessUnitSetCustomFieldAction,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<MyBusinessUnitSetCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference