Package com.commercetools.api.models.state

Interface StateSetDescriptionAction

All Superinterfaces:

ResourceUpdateAction<StateUpdateAction>, StateUpdateAction

All Known Implementing Classes:

StateSetDescriptionActionImpl

public interface StateSetDescriptionAction
extends StateUpdateAction

StateSetDescriptionAction Example to create an instance using the builder pattern

     StateSetDescriptionAction stateSetDescriptionAction = StateSetDescriptionAction.builder()
             .description(descriptionBuilder -> descriptionBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DESCRIPTION	discriminator value for StateSetDescriptionAction

Method Summary

Modifier and Type	Method	Description
static StateSetDescriptionActionBuilder	builder()	builder factory method for StateSetDescriptionAction
static StateSetDescriptionActionBuilder	builder(StateSetDescriptionAction template)	create builder for StateSetDescriptionAction instance
static StateSetDescriptionAction	deepCopy(StateSetDescriptionAction template)	factory method to create a deep copy of StateSetDescriptionAction
@NotNull @Valid LocalizedString	getDescription()	Value to set.
static StateSetDescriptionAction	of()	factory method
static StateSetDescriptionAction	of(StateSetDescriptionAction template)	factory method to create a shallow copy StateSetDescriptionAction
void	setDescription(LocalizedString description)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<StateSetDescriptionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStateSetDescriptionAction(Function<StateSetDescriptionAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.state.StateUpdateAction

getAction, withStateUpdateAction

Field Details

SET_DESCRIPTION

static final String SET_DESCRIPTION

discriminator value for StateSetDescriptionAction

See Also:

• Constant Field Values

Method Details

getDescription

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

Value to set. If empty, any existing value will be removed.

Returns:

description

setDescription

void setDescription(LocalizedString description)

Value to set. If empty, any existing value will be removed.

Parameters:

description - value to be set

of

static StateSetDescriptionAction of()

factory method

Returns:

instance of StateSetDescriptionAction

of

static StateSetDescriptionAction of(StateSetDescriptionAction template)

factory method to create a shallow copy StateSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StateSetDescriptionAction deepCopy(@Nullable
 StateSetDescriptionAction template)

factory method to create a deep copy of StateSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StateSetDescriptionActionBuilder builder()

builder factory method for StateSetDescriptionAction

Returns:

builder

builder

static StateSetDescriptionActionBuilder builder(StateSetDescriptionAction template)

create builder for StateSetDescriptionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStateSetDescriptionAction

default <T> T withStateSetDescriptionAction(Function<StateSetDescriptionAction,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<StateSetDescriptionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference