Package com.commercetools.api.models.category

Interface CategorySetCustomFieldAction

All Superinterfaces:

CategoryUpdateAction, ResourceUpdateAction<CategoryUpdateAction>

All Known Implementing Classes:

CategorySetCustomFieldActionImpl

public interface CategorySetCustomFieldAction
extends CategoryUpdateAction

CategorySetCustomFieldAction Example to create an instance using the builder pattern

     CategorySetCustomFieldAction categorySetCustomFieldAction = CategorySetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.category.CategoryUpdateAction

getAction, withCategoryUpdateAction

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

get

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for CategorySetCustomFieldAction

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

factory method

Returns:

instance of CategorySetCustomFieldAction

of

static CategorySetCustomFieldAction of(CategorySetCustomFieldAction template)

factory method to create a shallow copy CategorySetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CategorySetCustomFieldAction deepCopy(@Nullable
 CategorySetCustomFieldAction template)

factory method to create a deep copy of CategorySetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CategorySetCustomFieldActionBuilder builder()

builder factory method for CategorySetCustomFieldAction

Returns:

builder

builder

static CategorySetCustomFieldActionBuilder builder(CategorySetCustomFieldAction template)

create builder for CategorySetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCategorySetCustomFieldAction

default <T> T withCategorySetCustomFieldAction(Function<CategorySetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CategorySetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference