Package com.commercetools.api.models.channel

Interface ChannelChangeDescriptionAction

All Superinterfaces:

ChannelUpdateAction, ResourceUpdateAction<ChannelUpdateAction>

public interface ChannelChangeDescriptionAction
extends ChannelUpdateAction

ChannelChangeDescriptionAction Example to create an instance using the builder pattern

     ChannelChangeDescriptionAction channelChangeDescriptionAction = ChannelChangeDescriptionAction.builder()
             .description(descriptionBuilder -> descriptionBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_DESCRIPTION	discriminator value for ChannelChangeDescriptionAction

Method Summary

Modifier and Type	Method	Description
static ChannelChangeDescriptionActionBuilder	builder()	builder factory method for ChannelChangeDescriptionAction
static ChannelChangeDescriptionActionBuilder	builder(ChannelChangeDescriptionAction template)	create builder for ChannelChangeDescriptionAction instance
ChannelChangeDescriptionAction	copyDeep()
static ChannelChangeDescriptionAction	deepCopy(ChannelChangeDescriptionAction template)	factory method to create a deep copy of ChannelChangeDescriptionAction
@NotNull @Valid LocalizedString	getDescription()	New value to set.
static ChannelChangeDescriptionAction	of()	factory method
static ChannelChangeDescriptionAction	of(ChannelChangeDescriptionAction template)	factory method to create a shallow copy ChannelChangeDescriptionAction
void	setDescription(LocalizedString description)	New value to set.
static tools.jackson.core.type.TypeReference<ChannelChangeDescriptionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChannelChangeDescriptionAction(Function<ChannelChangeDescriptionAction,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

CHANGE_DESCRIPTION

static final String CHANGE_DESCRIPTION

discriminator value for ChannelChangeDescriptionAction

See Also:

• Constant Field Values

Method Details

getDescription

@NotNull
@Valid
@NotNull @Valid LocalizedString getDescription()

New value to set.

If set to an empty value, an InvalidOperation error is returned.

If the new value is the same as the current value, an InvalidOperation error is returned.

Returns:

description

setDescription

void setDescription(LocalizedString description)

New value to set.

If set to an empty value, an InvalidOperation error is returned.

If the new value is the same as the current value, an InvalidOperation error is returned.

Parameters:

description - value to be set

of

static ChannelChangeDescriptionAction of()

factory method

Returns:

instance of ChannelChangeDescriptionAction

of

static ChannelChangeDescriptionAction of(ChannelChangeDescriptionAction template)

factory method to create a shallow copy ChannelChangeDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ChannelChangeDescriptionAction copyDeep()

Specified by:

copyDeep in interface ChannelUpdateAction

deepCopy

@Nullable
static ChannelChangeDescriptionAction deepCopy(@Nullable
 ChannelChangeDescriptionAction template)

factory method to create a deep copy of ChannelChangeDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChannelChangeDescriptionActionBuilder builder()

builder factory method for ChannelChangeDescriptionAction

Returns:

builder

builder

static ChannelChangeDescriptionActionBuilder builder(ChannelChangeDescriptionAction template)

create builder for ChannelChangeDescriptionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChannelChangeDescriptionAction

default <T> T withChannelChangeDescriptionAction(Function<ChannelChangeDescriptionAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference