Package com.commercetools.api.models.shopping_list

Interface ShoppingListSetDescriptionAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

public interface ShoppingListSetDescriptionAction
extends ShoppingListUpdateAction

ShoppingListSetDescriptionAction Example to create an instance using the builder pattern

     ShoppingListSetDescriptionAction shoppingListSetDescriptionAction = ShoppingListSetDescriptionAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

get

Methods inherited from interface com.commercetools.api.models.shopping_list.ShoppingListUpdateAction

getAction, withShoppingListUpdateAction

Field Details

SET_DESCRIPTION

static final String SET_DESCRIPTION

discriminator value for ShoppingListSetDescriptionAction

See Also:

• Constant Field Values

Method Details

getDescription

@Valid
@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 ShoppingListSetDescriptionAction of()

factory method

Returns:

instance of ShoppingListSetDescriptionAction

of

static ShoppingListSetDescriptionAction of(ShoppingListSetDescriptionAction template)

factory method to create a shallow copy ShoppingListSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ShoppingListSetDescriptionAction deepCopy(@Nullable
 ShoppingListSetDescriptionAction template)

factory method to create a deep copy of ShoppingListSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListSetDescriptionActionBuilder builder()

builder factory method for ShoppingListSetDescriptionAction

Returns:

builder

builder

static ShoppingListSetDescriptionActionBuilder builder(ShoppingListSetDescriptionAction template)

create builder for ShoppingListSetDescriptionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListSetDescriptionAction

default <T> T withShoppingListSetDescriptionAction(Function<ShoppingListSetDescriptionAction,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<ShoppingListSetDescriptionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference