Package com.commercetools.api.models.shopping_list

Interface ShoppingListSetKeyAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

All Known Implementing Classes:

ShoppingListSetKeyActionImpl

public interface ShoppingListSetKeyAction
extends ShoppingListUpdateAction

ShoppingListSetKeyAction Example to create an instance using the builder pattern

     ShoppingListSetKeyAction shoppingListSetKeyAction = ShoppingListSetKeyAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_KEY	discriminator value for ShoppingListSetKeyAction

Method Summary

Modifier and Type	Method	Description
static ShoppingListSetKeyActionBuilder	builder()	builder factory method for ShoppingListSetKeyAction
static ShoppingListSetKeyActionBuilder	builder(ShoppingListSetKeyAction template)	create builder for ShoppingListSetKeyAction instance
static ShoppingListSetKeyAction	deepCopy(ShoppingListSetKeyAction template)	factory method to create a deep copy of ShoppingListSetKeyAction
String	getKey()	Value to set.
static ShoppingListSetKeyAction	of()	factory method
static ShoppingListSetKeyAction	of(ShoppingListSetKeyAction template)	factory method to create a shallow copy ShoppingListSetKeyAction
static ShoppingListSetKeyAction	ofUnset()
void	setKey(String key)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListSetKeyAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListSetKeyAction(Function<ShoppingListSetKeyAction,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_KEY

static final String SET_KEY

discriminator value for ShoppingListSetKeyAction

See Also:

• Constant Field Values

Method Details

getKey

String getKey()

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

Returns:

key

setKey

void setKey(String key)

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

Parameters:

key - value to be set

of

static ShoppingListSetKeyAction of()

factory method

Returns:

instance of ShoppingListSetKeyAction

of

static ShoppingListSetKeyAction of(ShoppingListSetKeyAction template)

factory method to create a shallow copy ShoppingListSetKeyAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ShoppingListSetKeyAction deepCopy(@Nullable
 ShoppingListSetKeyAction template)

factory method to create a deep copy of ShoppingListSetKeyAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListSetKeyActionBuilder builder()

builder factory method for ShoppingListSetKeyAction

Returns:

builder

builder

static ShoppingListSetKeyActionBuilder builder(ShoppingListSetKeyAction template)

create builder for ShoppingListSetKeyAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListSetKeyAction

default <T> T withShoppingListSetKeyAction(Function<ShoppingListSetKeyAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ShoppingListSetKeyAction ofUnset()

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference