Package com.commercetools.api.models.me

Interface MyShoppingListSetLineItemCustomFieldAction

All Superinterfaces:

MyShoppingListUpdateAction, ResourceUpdateAction<MyShoppingListUpdateAction>

public interface MyShoppingListSetLineItemCustomFieldAction
extends MyShoppingListUpdateAction

MyShoppingListSetLineItemCustomFieldAction Example to create an instance using the builder pattern

     MyShoppingListSetLineItemCustomFieldAction myShoppingListSetLineItemCustomFieldAction = MyShoppingListSetLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_CUSTOM_FIELD	discriminator value for MyShoppingListSetLineItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static MyShoppingListSetLineItemCustomFieldActionBuilder	builder()	builder factory method for MyShoppingListSetLineItemCustomFieldAction
static MyShoppingListSetLineItemCustomFieldActionBuilder	builder(MyShoppingListSetLineItemCustomFieldAction template)	create builder for MyShoppingListSetLineItemCustomFieldAction instance
MyShoppingListSetLineItemCustomFieldAction	copyDeep()
static MyShoppingListSetLineItemCustomFieldAction	deepCopy(MyShoppingListSetLineItemCustomFieldAction template)	factory method to create a deep copy of MyShoppingListSetLineItemCustomFieldAction
String	getLineItemId()	Unique identifier of an the ShoppingListLineItem.
String	getLineItemKey()	The key of the ShoppingListLineItem to update.
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static MyShoppingListSetLineItemCustomFieldAction	of()	factory method
static MyShoppingListSetLineItemCustomFieldAction	of(MyShoppingListSetLineItemCustomFieldAction template)	factory method to create a shallow copy MyShoppingListSetLineItemCustomFieldAction
void	setLineItemId(String lineItemId)	Unique identifier of an the ShoppingListLineItem.
void	setLineItemKey(String lineItemKey)	The key of the ShoppingListLineItem to update.
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	If value is absent or null, this field will be removed if it exists.
static com.fasterxml.jackson.core.type.TypeReference<MyShoppingListSetLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyShoppingListSetLineItemCustomFieldAction(Function<MyShoppingListSetLineItemCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyShoppingListUpdateAction

getAction, withMyShoppingListUpdateAction

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

get

Field Details

SET_LINE_ITEM_CUSTOM_FIELD

static final String SET_LINE_ITEM_CUSTOM_FIELD

discriminator value for MyShoppingListSetLineItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getLineItemId

String getLineItemId()

Unique identifier of an the ShoppingListLineItem. Either lineItemId or lineItemKey is required.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

The key of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemKey

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

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. If value is provided, it is set for the field defined by name.

Returns:

value

setLineItemId

void setLineItemId(String lineItemId)

Unique identifier of an the ShoppingListLineItem. Either lineItemId or lineItemKey is required.

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

The key of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemKey - value to be set

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

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. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static MyShoppingListSetLineItemCustomFieldAction of()

factory method

Returns:

instance of MyShoppingListSetLineItemCustomFieldAction

of

static MyShoppingListSetLineItemCustomFieldAction of(MyShoppingListSetLineItemCustomFieldAction template)

factory method to create a shallow copy MyShoppingListSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyShoppingListSetLineItemCustomFieldAction copyDeep()

Specified by:

copyDeep in interface MyShoppingListUpdateAction

deepCopy

@Nullable
static MyShoppingListSetLineItemCustomFieldAction deepCopy(@Nullable
 MyShoppingListSetLineItemCustomFieldAction template)

factory method to create a deep copy of MyShoppingListSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyShoppingListSetLineItemCustomFieldActionBuilder builder()

builder factory method for MyShoppingListSetLineItemCustomFieldAction

Returns:

builder

builder

static MyShoppingListSetLineItemCustomFieldActionBuilder builder(MyShoppingListSetLineItemCustomFieldAction template)

create builder for MyShoppingListSetLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyShoppingListSetLineItemCustomFieldAction

default <T> T withMyShoppingListSetLineItemCustomFieldAction(Function<MyShoppingListSetLineItemCustomFieldAction,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<MyShoppingListSetLineItemCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference