Package com.commercetools.api.models.associate_role

Interface AssociateRoleSetCustomFieldAction

All Superinterfaces:

AssociateRoleUpdateAction, ResourceUpdateAction<AssociateRoleUpdateAction>

public interface AssociateRoleSetCustomFieldAction
extends AssociateRoleUpdateAction

AssociateRoleSetCustomFieldAction Example to create an instance using the builder pattern

     AssociateRoleSetCustomFieldAction associateRoleSetCustomFieldAction = AssociateRoleSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.associate_role.AssociateRoleUpdateAction

getAction, withAssociateRoleUpdateAction

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

get

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for AssociateRoleSetCustomFieldAction

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. Trying to remove a field that does not exist will fail with an InvalidOperationError 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. Trying to remove a field that does not exist will fail with an InvalidOperationError error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static AssociateRoleSetCustomFieldAction of()

factory method

Returns:

instance of AssociateRoleSetCustomFieldAction

of

static AssociateRoleSetCustomFieldAction of(AssociateRoleSetCustomFieldAction template)

factory method to create a shallow copy AssociateRoleSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AssociateRoleSetCustomFieldAction copyDeep()

Specified by:

copyDeep in interface AssociateRoleUpdateAction

deepCopy

@Nullable
static AssociateRoleSetCustomFieldAction deepCopy(@Nullable
 AssociateRoleSetCustomFieldAction template)

factory method to create a deep copy of AssociateRoleSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AssociateRoleSetCustomFieldActionBuilder builder()

builder factory method for AssociateRoleSetCustomFieldAction

Returns:

builder

builder

static AssociateRoleSetCustomFieldActionBuilder builder(AssociateRoleSetCustomFieldAction template)

create builder for AssociateRoleSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAssociateRoleSetCustomFieldAction

default <T> T withAssociateRoleSetCustomFieldAction(Function<AssociateRoleSetCustomFieldAction,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<AssociateRoleSetCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference