Package com.commercetools.api.models.subscription

Interface SubscriptionSetKeyAction

All Superinterfaces:

ResourceUpdateAction<SubscriptionUpdateAction>, SubscriptionUpdateAction

All Known Implementing Classes:

SubscriptionSetKeyActionImpl

public interface SubscriptionSetKeyAction
extends SubscriptionUpdateAction

SubscriptionSetKeyAction Example to create an instance using the builder pattern

     SubscriptionSetKeyAction subscriptionSetKeyAction = SubscriptionSetKeyAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

get

Methods inherited from interface com.commercetools.api.models.subscription.SubscriptionUpdateAction

getAction, withSubscriptionUpdateAction

Field Details

SET_KEY

static final String SET_KEY

discriminator value for SubscriptionSetKeyAction

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 SubscriptionSetKeyAction of()

factory method

Returns:

instance of SubscriptionSetKeyAction

of

static SubscriptionSetKeyAction of(SubscriptionSetKeyAction template)

factory method to create a shallow copy SubscriptionSetKeyAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SubscriptionSetKeyAction deepCopy(@Nullable
 SubscriptionSetKeyAction template)

factory method to create a deep copy of SubscriptionSetKeyAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SubscriptionSetKeyActionBuilder builder()

builder factory method for SubscriptionSetKeyAction

Returns:

builder

builder

static SubscriptionSetKeyActionBuilder builder(SubscriptionSetKeyAction template)

create builder for SubscriptionSetKeyAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSubscriptionSetKeyAction

default <T> T withSubscriptionSetKeyAction(Function<SubscriptionSetKeyAction,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<SubscriptionSetKeyAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference