Package com.commercetools.api.models.review

Interface ReviewSetCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<ReviewUpdateAction>, ReviewUpdateAction

All Known Implementing Classes:

ReviewSetCustomFieldActionImpl

public interface ReviewSetCustomFieldAction
extends ReviewUpdateAction

ReviewSetCustomFieldAction Example to create an instance using the builder pattern

     ReviewSetCustomFieldAction reviewSetCustomFieldAction = ReviewSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

get

Methods inherited from interface com.commercetools.api.models.review.ReviewUpdateAction

getAction, withReviewUpdateAction

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for ReviewSetCustomFieldAction

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

factory method

Returns:

instance of ReviewSetCustomFieldAction

of

static ReviewSetCustomFieldAction of(ReviewSetCustomFieldAction template)

factory method to create a shallow copy ReviewSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ReviewSetCustomFieldAction deepCopy(@Nullable
 ReviewSetCustomFieldAction template)

factory method to create a deep copy of ReviewSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ReviewSetCustomFieldActionBuilder builder()

builder factory method for ReviewSetCustomFieldAction

Returns:

builder

builder

static ReviewSetCustomFieldActionBuilder builder(ReviewSetCustomFieldAction template)

create builder for ReviewSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withReviewSetCustomFieldAction

default <T> T withReviewSetCustomFieldAction(Function<ReviewSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ReviewSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference