Package com.commercetools.api.models.approval_flow

Interface ApprovalFlowSetCustomFieldAction

All Superinterfaces:

ApprovalFlowUpdateAction

public interface ApprovalFlowSetCustomFieldAction
extends ApprovalFlowUpdateAction

ApprovalFlowSetCustomFieldAction Example to create an instance using the builder pattern

     ApprovalFlowSetCustomFieldAction approvalFlowSetCustomFieldAction = ApprovalFlowSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.approval_flow.ApprovalFlowUpdateAction

getAction, withApprovalFlowUpdateAction

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for ApprovalFlowSetCustomFieldAction

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

factory method

Returns:

instance of ApprovalFlowSetCustomFieldAction

of

static ApprovalFlowSetCustomFieldAction of(ApprovalFlowSetCustomFieldAction template)

factory method to create a shallow copy ApprovalFlowSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ApprovalFlowSetCustomFieldAction copyDeep()

Specified by:

copyDeep in interface ApprovalFlowUpdateAction

deepCopy

@Nullable
static ApprovalFlowSetCustomFieldAction deepCopy(@Nullable
 ApprovalFlowSetCustomFieldAction template)

factory method to create a deep copy of ApprovalFlowSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalFlowSetCustomFieldActionBuilder builder()

builder factory method for ApprovalFlowSetCustomFieldAction

Returns:

builder

builder

static ApprovalFlowSetCustomFieldActionBuilder builder(ApprovalFlowSetCustomFieldAction template)

create builder for ApprovalFlowSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalFlowSetCustomFieldAction

default <T> T withApprovalFlowSetCustomFieldAction(Function<ApprovalFlowSetCustomFieldAction,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<ApprovalFlowSetCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference