Package com.commercetools.api.models.recurring_order

Interface RecurringOrderSetKeyAction

All Superinterfaces:

RecurringOrderUpdateAction

public interface RecurringOrderSetKeyAction
extends RecurringOrderUpdateAction

This update action generates the RecurringOrderKeySet Message.

Example to create an instance using the builder pattern

     RecurringOrderSetKeyAction recurringOrderSetKeyAction = RecurringOrderSetKeyAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static RecurringOrderSetKeyActionBuilder	builder()	builder factory method for RecurringOrderSetKeyAction
static RecurringOrderSetKeyActionBuilder	builder(RecurringOrderSetKeyAction template)	create builder for RecurringOrderSetKeyAction instance
RecurringOrderSetKeyAction	copyDeep()
static RecurringOrderSetKeyAction	deepCopy(RecurringOrderSetKeyAction template)	factory method to create a deep copy of RecurringOrderSetKeyAction
String	getKey()	Value to set.
static RecurringOrderSetKeyAction	of()	factory method
static RecurringOrderSetKeyAction	of(RecurringOrderSetKeyAction template)	factory method to create a shallow copy RecurringOrderSetKeyAction
void	setKey(String key)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderSetKeyAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderSetKeyAction(Function<RecurringOrderSetKeyAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.recurring_order.RecurringOrderUpdateAction

getAction, withRecurringOrderUpdateAction

Field Details

SET_KEY

static final String SET_KEY

discriminator value for RecurringOrderSetKeyAction

See Also:

• Constant Field Values

Method Details

getKey

String getKey()

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

Returns:

key

setKey

void setKey(String key)

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

Parameters:

key - value to be set

of

static RecurringOrderSetKeyAction of()

factory method

Returns:

instance of RecurringOrderSetKeyAction

of

static RecurringOrderSetKeyAction of(RecurringOrderSetKeyAction template)

factory method to create a shallow copy RecurringOrderSetKeyAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderSetKeyAction copyDeep()

Specified by:

copyDeep in interface RecurringOrderUpdateAction

deepCopy

@Nullable
static RecurringOrderSetKeyAction deepCopy(@Nullable
 RecurringOrderSetKeyAction template)

factory method to create a deep copy of RecurringOrderSetKeyAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderSetKeyActionBuilder builder()

builder factory method for RecurringOrderSetKeyAction

Returns:

builder

builder

static RecurringOrderSetKeyActionBuilder builder(RecurringOrderSetKeyAction template)

create builder for RecurringOrderSetKeyAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderSetKeyAction

default <T> T withRecurringOrderSetKeyAction(Function<RecurringOrderSetKeyAction,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<RecurringOrderSetKeyAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference