Package com.commercetools.api.models.product_type

Interface ProductTypeRemoveEnumValuesAction

All Superinterfaces:

ProductTypeUpdateAction, ResourceUpdateAction<ProductTypeUpdateAction>

All Known Implementing Classes:

ProductTypeRemoveEnumValuesActionImpl

public interface ProductTypeRemoveEnumValuesAction
extends ProductTypeUpdateAction

Removes enum values from an AttributeDefinition of AttributeEnumType, AttributeLocalizedEnumType, AttributeSetType of AttributeEnumType, or AttributeSetType of AttributeLocalizedEnumType.

If the Attribute is not required, the Attributes of all Products using those enum keys will also be removed in an eventually consistent way. If the Attribute is required, the operation returns an EnumValueIsUsed error.

Example to create an instance using the builder pattern

     ProductTypeRemoveEnumValuesAction productTypeRemoveEnumValuesAction = ProductTypeRemoveEnumValuesAction.builder()
             .attributeName("{attributeName}")
             .plusKeys(keysBuilder -> keysBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_ENUM_VALUES	discriminator value for ProductTypeRemoveEnumValuesAction

Method Summary

Modifier and Type	Method	Description
static ProductTypeRemoveEnumValuesActionBuilder	builder()	builder factory method for ProductTypeRemoveEnumValuesAction
static ProductTypeRemoveEnumValuesActionBuilder	builder(ProductTypeRemoveEnumValuesAction template)	create builder for ProductTypeRemoveEnumValuesAction instance
static ProductTypeRemoveEnumValuesAction	deepCopy(ProductTypeRemoveEnumValuesAction template)	factory method to create a deep copy of ProductTypeRemoveEnumValuesAction
@NotNull String	getAttributeName()	Name of the AttributeDefinition to update.
@NotNull List<String>	getKeys()	Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.
static ProductTypeRemoveEnumValuesAction	of()	factory method
static ProductTypeRemoveEnumValuesAction	of(ProductTypeRemoveEnumValuesAction template)	factory method to create a shallow copy ProductTypeRemoveEnumValuesAction
void	setAttributeName(String attributeName)	Name of the AttributeDefinition to update.
void	setKeys(String... keys)	Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.
void	setKeys(List<String> keys)	Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.
static com.fasterxml.jackson.core.type.TypeReference<ProductTypeRemoveEnumValuesAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductTypeRemoveEnumValuesAction(Function<ProductTypeRemoveEnumValuesAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product_type.ProductTypeUpdateAction

getAction, withProductTypeUpdateAction

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

get

Field Details

REMOVE_ENUM_VALUES

static final String REMOVE_ENUM_VALUES

discriminator value for ProductTypeRemoveEnumValuesAction

See Also:

• Constant Field Values

Method Details

getAttributeName

@NotNull
@NotNull String getAttributeName()

Name of the AttributeDefinition to update.

Returns:

attributeName

getKeys

@NotNull
@NotNull List<String> getKeys()

Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.

Returns:

keys

setAttributeName

void setAttributeName(String attributeName)

Name of the AttributeDefinition to update.

Parameters:

attributeName - value to be set

setKeys

void setKeys(String... keys)

Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.

Parameters:

keys - values to be set

setKeys

void setKeys(List<String> keys)

Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.

Parameters:

keys - values to be set

of

static ProductTypeRemoveEnumValuesAction of()

factory method

Returns:

instance of ProductTypeRemoveEnumValuesAction

of

static ProductTypeRemoveEnumValuesAction of(ProductTypeRemoveEnumValuesAction template)

factory method to create a shallow copy ProductTypeRemoveEnumValuesAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductTypeRemoveEnumValuesAction deepCopy(@Nullable
 ProductTypeRemoveEnumValuesAction template)

factory method to create a deep copy of ProductTypeRemoveEnumValuesAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductTypeRemoveEnumValuesActionBuilder builder()

builder factory method for ProductTypeRemoveEnumValuesAction

Returns:

builder

builder

static ProductTypeRemoveEnumValuesActionBuilder builder(ProductTypeRemoveEnumValuesAction template)

create builder for ProductTypeRemoveEnumValuesAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductTypeRemoveEnumValuesAction

default <T> T withProductTypeRemoveEnumValuesAction(Function<ProductTypeRemoveEnumValuesAction,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<ProductTypeRemoveEnumValuesAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference