Package com.commercetools.api.models.type

Interface TypeRemoveLocalizedEnumValuesAction

All Superinterfaces:

ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction

public interface TypeRemoveLocalizedEnumValuesAction
extends TypeUpdateAction

Removes LocalizedEnumValues from a LocalizedEnumType FieldDefinition. This update action can be used to update a LocalizedEnumType FieldDefinition and a SetType FieldDefinition of LocalizedEnumType.

This update action is always allowed, even if the FieldDefinition is required and even if a resource still has a Custom Field value referencing one of the removed keys. Existing Custom Field values are not updated or removed by this update action, and are returned unchanged until they are explicitly updated. Note that a subsequent update of a single Custom Field on such a resource can fail, because that update revalidates all Custom Field values on the resource.

Example to create an instance using the builder pattern

     TypeRemoveLocalizedEnumValuesAction typeRemoveLocalizedEnumValuesAction = TypeRemoveLocalizedEnumValuesAction.builder()
             .fieldName("{fieldName}")
             .plusKeys(keysBuilder -> keysBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_LOCALIZED_ENUM_VALUES	discriminator value for TypeRemoveLocalizedEnumValuesAction

Method Summary

Modifier and Type	Method	Description
static TypeRemoveLocalizedEnumValuesActionBuilder	builder()	builder factory method for TypeRemoveLocalizedEnumValuesAction
static TypeRemoveLocalizedEnumValuesActionBuilder	builder(TypeRemoveLocalizedEnumValuesAction template)	create builder for TypeRemoveLocalizedEnumValuesAction instance
TypeRemoveLocalizedEnumValuesAction	copyDeep()
static TypeRemoveLocalizedEnumValuesAction	deepCopy(TypeRemoveLocalizedEnumValuesAction template)	factory method to create a deep copy of TypeRemoveLocalizedEnumValuesAction
@NotNull String	getFieldName()	name of the FieldDefinition to update.
@NotNull List<String>	getKeys()	Keys of the LocalizedEnumValues to remove.
static TypeRemoveLocalizedEnumValuesAction	of()	factory method
static TypeRemoveLocalizedEnumValuesAction	of(TypeRemoveLocalizedEnumValuesAction template)	factory method to create a shallow copy TypeRemoveLocalizedEnumValuesAction
void	setFieldName(String fieldName)	name of the FieldDefinition to update.
void	setKeys(String... keys)	Keys of the LocalizedEnumValues to remove.
void	setKeys(List<String> keys)	Keys of the LocalizedEnumValues to remove.
static tools.jackson.core.type.TypeReference<TypeRemoveLocalizedEnumValuesAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTypeRemoveLocalizedEnumValuesAction(Function<TypeRemoveLocalizedEnumValuesAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.type.TypeUpdateAction

getAction, withTypeUpdateAction

Field Details

REMOVE_LOCALIZED_ENUM_VALUES

static final String REMOVE_LOCALIZED_ENUM_VALUES

discriminator value for TypeRemoveLocalizedEnumValuesAction

See Also:

• Constant Field Values

Method Details

getFieldName

@NotNull
@NotNull String getFieldName()

name of the FieldDefinition to update.

Returns:

fieldName

getKeys

@NotNull
@NotNull List<String> getKeys()

Keys of the LocalizedEnumValues to remove. An empty array results in no change.

Returns:

keys

setFieldName

void setFieldName(String fieldName)

name of the FieldDefinition to update.

Parameters:

fieldName - value to be set

setKeys

void setKeys(String... keys)

Keys of the LocalizedEnumValues to remove. An empty array results in no change.

Parameters:

keys - values to be set

setKeys

void setKeys(List<String> keys)

Keys of the LocalizedEnumValues to remove. An empty array results in no change.

Parameters:

keys - values to be set

of

static TypeRemoveLocalizedEnumValuesAction of()

factory method

Returns:

instance of TypeRemoveLocalizedEnumValuesAction

of

static TypeRemoveLocalizedEnumValuesAction of(TypeRemoveLocalizedEnumValuesAction template)

factory method to create a shallow copy TypeRemoveLocalizedEnumValuesAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

TypeRemoveLocalizedEnumValuesAction copyDeep()

Specified by:

copyDeep in interface TypeUpdateAction

deepCopy

@Nullable
static TypeRemoveLocalizedEnumValuesAction deepCopy(@Nullable
 TypeRemoveLocalizedEnumValuesAction template)

factory method to create a deep copy of TypeRemoveLocalizedEnumValuesAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TypeRemoveLocalizedEnumValuesActionBuilder builder()

builder factory method for TypeRemoveLocalizedEnumValuesAction

Returns:

builder

builder

static TypeRemoveLocalizedEnumValuesActionBuilder builder(TypeRemoveLocalizedEnumValuesAction template)

create builder for TypeRemoveLocalizedEnumValuesAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTypeRemoveLocalizedEnumValuesAction

default <T> T withTypeRemoveLocalizedEnumValuesAction(Function<TypeRemoveLocalizedEnumValuesAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<TypeRemoveLocalizedEnumValuesAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference