Package com.commercetools.api.models.subscription

Interface SubscriptionUpdate

All Superinterfaces:

ResourceUpdate<SubscriptionUpdate,SubscriptionUpdateAction,SubscriptionUpdateBuilder>

public interface SubscriptionUpdate
extends ResourceUpdate<SubscriptionUpdate,SubscriptionUpdateAction,SubscriptionUpdateBuilder>

SubscriptionUpdate Example to create an instance using the builder pattern

     SubscriptionUpdate subscriptionUpdate = SubscriptionUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static SubscriptionUpdateBuilder	builder()	builder factory method for SubscriptionUpdate
static SubscriptionUpdateBuilder	builder(SubscriptionUpdate template)	create builder for SubscriptionUpdate instance
SubscriptionUpdate	copyDeep()
static SubscriptionUpdate	deepCopy(SubscriptionUpdate template)	factory method to create a deep copy of SubscriptionUpdate
@NotNull @Valid List<SubscriptionUpdateAction>	getActions()	Update actions to be performed on the Subscription.
@NotNull Long	getVersion()	Expected version of the Subscription on which the changes should be applied.
static SubscriptionUpdate	of()	factory method
static SubscriptionUpdate	of(SubscriptionUpdate template)	factory method to create a shallow copy SubscriptionUpdate
void	setActions(SubscriptionUpdateAction... actions)	Update actions to be performed on the Subscription.
void	setActions(List<SubscriptionUpdateAction> actions)	Update actions to be performed on the Subscription.
void	setVersion(Long version)	Expected version of the Subscription on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<SubscriptionUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSubscriptionUpdate(Function<SubscriptionUpdate,T> helper)	accessor map function

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

get

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

Expected version of the Subscription on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

getVersion in interface ResourceUpdate<SubscriptionUpdate,SubscriptionUpdateAction,SubscriptionUpdateBuilder>

Returns:

version

getActions

@NotNull
@Valid
@NotNull @Valid List<SubscriptionUpdateAction> getActions()

Update actions to be performed on the Subscription.

Specified by:

getActions in interface ResourceUpdate<SubscriptionUpdate,SubscriptionUpdateAction,SubscriptionUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

Expected version of the Subscription on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

setVersion in interface ResourceUpdate<SubscriptionUpdate,SubscriptionUpdateAction,SubscriptionUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(SubscriptionUpdateAction... actions)

Update actions to be performed on the Subscription.

Parameters:

actions - values to be set

setActions

void setActions(List<SubscriptionUpdateAction> actions)

Update actions to be performed on the Subscription.

Specified by:

setActions in interface ResourceUpdate<SubscriptionUpdate,SubscriptionUpdateAction,SubscriptionUpdateBuilder>

Parameters:

actions - values to be set

of

static SubscriptionUpdate of()

factory method

Returns:

instance of SubscriptionUpdate

of

static SubscriptionUpdate of(SubscriptionUpdate template)

factory method to create a shallow copy SubscriptionUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

SubscriptionUpdate copyDeep()

deepCopy

@Nullable
static SubscriptionUpdate deepCopy(@Nullable
 SubscriptionUpdate template)

factory method to create a deep copy of SubscriptionUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SubscriptionUpdateBuilder builder()

builder factory method for SubscriptionUpdate

Returns:

builder

builder

static SubscriptionUpdateBuilder builder(SubscriptionUpdate template)

create builder for SubscriptionUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSubscriptionUpdate

default <T> T withSubscriptionUpdate(Function<SubscriptionUpdate,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<SubscriptionUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference