Package com.commercetools.api.models.approval_rule

Interface ApprovalRuleSetCustomFieldAction

All Superinterfaces:

ApprovalRuleUpdateAction

public interface ApprovalRuleSetCustomFieldAction
extends ApprovalRuleUpdateAction

ApprovalRuleSetCustomFieldAction Example to create an instance using the builder pattern

     ApprovalRuleSetCustomFieldAction approvalRuleSetCustomFieldAction = ApprovalRuleSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.approval_rule.ApprovalRuleUpdateAction

getAction, withApprovalRuleUpdateAction

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for ApprovalRuleSetCustomFieldAction

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

factory method

Returns:

instance of ApprovalRuleSetCustomFieldAction

of

static ApprovalRuleSetCustomFieldAction of(ApprovalRuleSetCustomFieldAction template)

factory method to create a shallow copy ApprovalRuleSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ApprovalRuleSetCustomFieldAction copyDeep()

Specified by:

copyDeep in interface ApprovalRuleUpdateAction

deepCopy

@Nullable
static ApprovalRuleSetCustomFieldAction deepCopy(@Nullable
 ApprovalRuleSetCustomFieldAction template)

factory method to create a deep copy of ApprovalRuleSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalRuleSetCustomFieldActionBuilder builder()

builder factory method for ApprovalRuleSetCustomFieldAction

Returns:

builder

builder

static ApprovalRuleSetCustomFieldActionBuilder builder(ApprovalRuleSetCustomFieldAction template)

create builder for ApprovalRuleSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalRuleSetCustomFieldAction

default <T> T withApprovalRuleSetCustomFieldAction(Function<ApprovalRuleSetCustomFieldAction,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<ApprovalRuleSetCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference