Package com.commercetools.api.models.store

Interface StoreSetCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StoreUpdateAction>, StoreUpdateAction

All Known Implementing Classes:

StoreSetCustomFieldActionImpl

public interface StoreSetCustomFieldAction
extends StoreUpdateAction

StoreSetCustomFieldAction Example to create an instance using the builder pattern

     StoreSetCustomFieldAction storeSetCustomFieldAction = StoreSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

get

Methods inherited from interface com.commercetools.api.models.store.StoreUpdateAction

getAction, withStoreUpdateAction

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for StoreSetCustomFieldAction

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

factory method

Returns:

instance of StoreSetCustomFieldAction

of

static StoreSetCustomFieldAction of(StoreSetCustomFieldAction template)

factory method to create a shallow copy StoreSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StoreSetCustomFieldAction deepCopy(@Nullable
 StoreSetCustomFieldAction template)

factory method to create a deep copy of StoreSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StoreSetCustomFieldActionBuilder builder()

builder factory method for StoreSetCustomFieldAction

Returns:

builder

builder

static StoreSetCustomFieldActionBuilder builder(StoreSetCustomFieldAction template)

create builder for StoreSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStoreSetCustomFieldAction

default <T> T withStoreSetCustomFieldAction(Function<StoreSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StoreSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference