Package com.commercetools.api.models.channel

Interface ChannelSetAddressCustomFieldAction

All Superinterfaces:

ChannelUpdateAction, ResourceUpdateAction<ChannelUpdateAction>

public interface ChannelSetAddressCustomFieldAction
extends ChannelUpdateAction

To set a Custom Field for a Channel, Channel.address must be set; otherwise, an InvalidInput error is returned.

Example to create an instance using the builder pattern

     ChannelSetAddressCustomFieldAction channelSetAddressCustomFieldAction = ChannelSetAddressCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_FIELD	discriminator value for ChannelSetAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static ChannelSetAddressCustomFieldActionBuilder	builder()	builder factory method for ChannelSetAddressCustomFieldAction
static ChannelSetAddressCustomFieldActionBuilder	builder(ChannelSetAddressCustomFieldAction template)	create builder for ChannelSetAddressCustomFieldAction instance
ChannelSetAddressCustomFieldAction	copyDeep()
static ChannelSetAddressCustomFieldAction	deepCopy(ChannelSetAddressCustomFieldAction template)	factory method to create a deep copy of ChannelSetAddressCustomFieldAction
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	Specifies the format of the value of the Custom Field defined by name.
static ChannelSetAddressCustomFieldAction	of()	factory method
static ChannelSetAddressCustomFieldAction	of(ChannelSetAddressCustomFieldAction template)	factory method to create a shallow copy ChannelSetAddressCustomFieldAction
static ChannelSetAddressCustomFieldAction	ofUnset(String name)
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	Specifies the format of the value of the Custom Field defined by name.
static tools.jackson.core.type.TypeReference<ChannelSetAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChannelSetAddressCustomFieldAction(Function<ChannelSetAddressCustomFieldAction,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_ADDRESS_CUSTOM_FIELD

static final String SET_ADDRESS_CUSTOM_FIELD

discriminator value for ChannelSetAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

Specifies the format of the value of the Custom Field defined by name. 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.

Returns:

value

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

Specifies the format of the value of the Custom Field defined by name. 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.

Parameters:

value - value to be set

of

static ChannelSetAddressCustomFieldAction of()

factory method

Returns:

instance of ChannelSetAddressCustomFieldAction

of

static ChannelSetAddressCustomFieldAction of(ChannelSetAddressCustomFieldAction template)

factory method to create a shallow copy ChannelSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ChannelSetAddressCustomFieldAction copyDeep()

Specified by:

copyDeep in interface ChannelUpdateAction

deepCopy

@Nullable
static ChannelSetAddressCustomFieldAction deepCopy(@Nullable
 ChannelSetAddressCustomFieldAction template)

factory method to create a deep copy of ChannelSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChannelSetAddressCustomFieldActionBuilder builder()

builder factory method for ChannelSetAddressCustomFieldAction

Returns:

builder

builder

static ChannelSetAddressCustomFieldActionBuilder builder(ChannelSetAddressCustomFieldAction template)

create builder for ChannelSetAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChannelSetAddressCustomFieldAction

default <T> T withChannelSetAddressCustomFieldAction(Function<ChannelSetAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ChannelSetAddressCustomFieldAction ofUnset(String name)

typeReference

static tools.jackson.core.type.TypeReference<ChannelSetAddressCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference