Package com.commercetools.api.models.channel

Interface ChannelSetCustomFieldAction

All Superinterfaces:

ChannelUpdateAction, ResourceUpdateAction<ChannelUpdateAction>

All Known Implementing Classes:

ChannelSetCustomFieldActionImpl

public interface ChannelSetCustomFieldAction
extends ChannelUpdateAction

ChannelSetCustomFieldAction Example to create an instance using the builder pattern

     ChannelSetCustomFieldAction channelSetCustomFieldAction = ChannelSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.channel.ChannelUpdateAction

getAction, withChannelUpdateAction

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

get

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for ChannelSetCustomFieldAction

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

factory method

Returns:

instance of ChannelSetCustomFieldAction

of

static ChannelSetCustomFieldAction of(ChannelSetCustomFieldAction template)

factory method to create a shallow copy ChannelSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChannelSetCustomFieldAction deepCopy(@Nullable
 ChannelSetCustomFieldAction template)

factory method to create a deep copy of ChannelSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChannelSetCustomFieldActionBuilder builder()

builder factory method for ChannelSetCustomFieldAction

Returns:

builder

builder

static ChannelSetCustomFieldActionBuilder builder(ChannelSetCustomFieldAction template)

create builder for ChannelSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChannelSetCustomFieldAction

default <T> T withChannelSetCustomFieldAction(Function<ChannelSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ChannelSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference