Package com.commercetools.api.models.zone

Interface ZoneUpdate

All Superinterfaces:

ResourceUpdate<ZoneUpdate,ZoneUpdateAction,ZoneUpdateBuilder>

All Known Implementing Classes:

ZoneUpdateImpl

public interface ZoneUpdate
extends ResourceUpdate<ZoneUpdate,ZoneUpdateAction,ZoneUpdateBuilder>

ZoneUpdate Example to create an instance using the builder pattern

     ZoneUpdate zoneUpdate = ZoneUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ZoneUpdateBuilder	builder()	builder factory method for ZoneUpdate
static ZoneUpdateBuilder	builder(ZoneUpdate template)	create builder for ZoneUpdate instance
static ZoneUpdate	deepCopy(ZoneUpdate template)	factory method to create a deep copy of ZoneUpdate
@NotNull @Valid List<ZoneUpdateAction>	getActions()	Update actions to be performed on the Zone.
@NotNull Long	getVersion()	Expected version of the Zone on which the changes should be applied.
static ZoneUpdate	of()	factory method
static ZoneUpdate	of(ZoneUpdate template)	factory method to create a shallow copy ZoneUpdate
void	setActions(ZoneUpdateAction... actions)	Update actions to be performed on the Zone.
void	setActions(List<ZoneUpdateAction> actions)	Update actions to be performed on the Zone.
void	setVersion(Long version)	Expected version of the Zone on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<ZoneUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withZoneUpdate(Function<ZoneUpdate,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 Zone on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error is returned.

Specified by:

getVersion in interface ResourceUpdate<ZoneUpdate,ZoneUpdateAction,ZoneUpdateBuilder>

Returns:

version

getActions

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

Update actions to be performed on the Zone.

Specified by:

getActions in interface ResourceUpdate<ZoneUpdate,ZoneUpdateAction,ZoneUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

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

Specified by:

setVersion in interface ResourceUpdate<ZoneUpdate,ZoneUpdateAction,ZoneUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(ZoneUpdateAction... actions)

Update actions to be performed on the Zone.

Parameters:

actions - values to be set

setActions

void setActions(List<ZoneUpdateAction> actions)

Update actions to be performed on the Zone.

Specified by:

setActions in interface ResourceUpdate<ZoneUpdate,ZoneUpdateAction,ZoneUpdateBuilder>

Parameters:

actions - values to be set

of

static ZoneUpdate of()

factory method

Returns:

instance of ZoneUpdate

of

static ZoneUpdate of(ZoneUpdate template)

factory method to create a shallow copy ZoneUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ZoneUpdate deepCopy(@Nullable
 ZoneUpdate template)

factory method to create a deep copy of ZoneUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ZoneUpdateBuilder builder()

builder factory method for ZoneUpdate

Returns:

builder

builder

static ZoneUpdateBuilder builder(ZoneUpdate template)

create builder for ZoneUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withZoneUpdate

default <T> T withZoneUpdate(Function<ZoneUpdate,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<ZoneUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference