Package com.commercetools.api.models.me

Interface MyShoppingListSetTextLineItemCustomFieldAction

All Superinterfaces:

MyShoppingListUpdateAction, ResourceUpdateAction<MyShoppingListUpdateAction>

public interface MyShoppingListSetTextLineItemCustomFieldAction
extends MyShoppingListUpdateAction

MyShoppingListSetTextLineItemCustomFieldAction Example to create an instance using the builder pattern

     MyShoppingListSetTextLineItemCustomFieldAction myShoppingListSetTextLineItemCustomFieldAction = MyShoppingListSetTextLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_TEXT_LINE_ITEM_CUSTOM_FIELD	discriminator value for MyShoppingListSetTextLineItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static MyShoppingListSetTextLineItemCustomFieldActionBuilder	builder()	builder factory method for MyShoppingListSetTextLineItemCustomFieldAction
static MyShoppingListSetTextLineItemCustomFieldActionBuilder	builder(MyShoppingListSetTextLineItemCustomFieldAction template)	create builder for MyShoppingListSetTextLineItemCustomFieldAction instance
MyShoppingListSetTextLineItemCustomFieldAction	copyDeep()
static MyShoppingListSetTextLineItemCustomFieldAction	deepCopy(MyShoppingListSetTextLineItemCustomFieldAction template)	factory method to create a deep copy of MyShoppingListSetTextLineItemCustomFieldAction
@NotNull String	getName()	Name of the Custom Field.
String	getTextLineItemId()	The id of the TextLineItem to update.
String	getTextLineItemKey()	The key of the TextLineItem to update.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static MyShoppingListSetTextLineItemCustomFieldAction	of()	factory method
static MyShoppingListSetTextLineItemCustomFieldAction	of(MyShoppingListSetTextLineItemCustomFieldAction template)	factory method to create a shallow copy MyShoppingListSetTextLineItemCustomFieldAction
void	setName(String name)	Name of the Custom Field.
void	setTextLineItemId(String textLineItemId)	The id of the TextLineItem to update.
void	setTextLineItemKey(String textLineItemKey)	The key of the TextLineItem to update.
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<MyShoppingListSetTextLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyShoppingListSetTextLineItemCustomFieldAction(Function<MyShoppingListSetTextLineItemCustomFieldAction,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_TEXT_LINE_ITEM_CUSTOM_FIELD

static final String SET_TEXT_LINE_ITEM_CUSTOM_FIELD

discriminator value for MyShoppingListSetTextLineItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getTextLineItemId

String getTextLineItemId()

The id of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Returns:

textLineItemId

getTextLineItemKey

String getTextLineItemKey()

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

Returns:

textLineItemKey

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

setTextLineItemId

void setTextLineItemId(String textLineItemId)

The id of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

textLineItemId - value to be set

setTextLineItemKey

void setTextLineItemKey(String textLineItemKey)

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

Parameters:

textLineItemKey - 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 MyShoppingListSetTextLineItemCustomFieldAction of()

factory method

Returns:

instance of MyShoppingListSetTextLineItemCustomFieldAction

of

static MyShoppingListSetTextLineItemCustomFieldAction of(MyShoppingListSetTextLineItemCustomFieldAction template)

factory method to create a shallow copy MyShoppingListSetTextLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyShoppingListSetTextLineItemCustomFieldAction copyDeep()

Specified by:

copyDeep in interface MyShoppingListUpdateAction

deepCopy

@Nullable
static MyShoppingListSetTextLineItemCustomFieldAction deepCopy(@Nullable
 MyShoppingListSetTextLineItemCustomFieldAction template)

factory method to create a deep copy of MyShoppingListSetTextLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyShoppingListSetTextLineItemCustomFieldActionBuilder builder()

builder factory method for MyShoppingListSetTextLineItemCustomFieldAction

Returns:

builder

builder

static MyShoppingListSetTextLineItemCustomFieldActionBuilder builder(MyShoppingListSetTextLineItemCustomFieldAction template)

create builder for MyShoppingListSetTextLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyShoppingListSetTextLineItemCustomFieldAction

default <T> T withMyShoppingListSetTextLineItemCustomFieldAction(Function<MyShoppingListSetTextLineItemCustomFieldAction,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<MyShoppingListSetTextLineItemCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference