Package com.commercetools.api.models.shopping_list

Interface ShoppingListSetCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

All Known Implementing Classes:

ShoppingListSetCustomFieldActionImpl

public interface ShoppingListSetCustomFieldAction
extends ShoppingListUpdateAction

ShoppingListSetCustomFieldAction Example to create an instance using the builder pattern

     ShoppingListSetCustomFieldAction shoppingListSetCustomFieldAction = ShoppingListSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

get

Methods inherited from interface com.commercetools.api.models.shopping_list.ShoppingListUpdateAction

getAction, withShoppingListUpdateAction

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for ShoppingListSetCustomFieldAction

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. Removing a field that does not exist returns 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. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static ShoppingListSetCustomFieldAction of()

factory method

Returns:

instance of ShoppingListSetCustomFieldAction

of

static ShoppingListSetCustomFieldAction of(ShoppingListSetCustomFieldAction template)

factory method to create a shallow copy ShoppingListSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ShoppingListSetCustomFieldAction deepCopy(@Nullable
 ShoppingListSetCustomFieldAction template)

factory method to create a deep copy of ShoppingListSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListSetCustomFieldActionBuilder builder()

builder factory method for ShoppingListSetCustomFieldAction

Returns:

builder

builder

static ShoppingListSetCustomFieldActionBuilder builder(ShoppingListSetCustomFieldAction template)

create builder for ShoppingListSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListSetCustomFieldAction

default <T> T withShoppingListSetCustomFieldAction(Function<ShoppingListSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ShoppingListSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference