Package com.commercetools.api.models.product

Interface ProductRemoveVariantAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductRemoveVariantActionImpl

public interface ProductRemoveVariantAction
extends ProductUpdateAction

Either id or sku is required. Produces the ProductVariantDeleted Message. If the Product Variant to remove is part of a ProductSelectionAssignment its SKU will be automatically removed from the respective ProductVariantSelection.

Example to create an instance using the builder pattern

     ProductRemoveVariantAction productRemoveVariantAction = ProductRemoveVariantAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_VARIANT	discriminator value for ProductRemoveVariantAction

Method Summary

Modifier and Type	Method	Description
static ProductRemoveVariantActionBuilder	builder()	builder factory method for ProductRemoveVariantAction
static ProductRemoveVariantActionBuilder	builder(ProductRemoveVariantAction template)	create builder for ProductRemoveVariantAction instance
static ProductRemoveVariantAction	deepCopy(ProductRemoveVariantAction template)	factory method to create a deep copy of ProductRemoveVariantAction
Long	getId()	The id of the ProductVariant to remove.
String	getSku()	The sku of the ProductVariant to remove.
Boolean	getStaged()	If true, only the staged ProductVariant is removed.
static ProductRemoveVariantAction	of()	factory method
static ProductRemoveVariantAction	of(ProductRemoveVariantAction template)	factory method to create a shallow copy ProductRemoveVariantAction
void	setId(Long id)	The id of the ProductVariant to remove.
void	setSku(String sku)	The sku of the ProductVariant to remove.
void	setStaged(Boolean staged)	If true, only the staged ProductVariant is removed.
static com.fasterxml.jackson.core.type.TypeReference<ProductRemoveVariantAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductRemoveVariantAction(Function<ProductRemoveVariantAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product.ProductUpdateAction

getAction, withProductUpdateAction

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

get

Field Details

REMOVE_VARIANT

static final String REMOVE_VARIANT

discriminator value for ProductRemoveVariantAction

See Also:

• Constant Field Values

Method Details

getId

Long getId()

The id of the ProductVariant to remove.

Returns:

id

getSku

String getSku()

The sku of the ProductVariant to remove.

Returns:

sku

getStaged

Boolean getStaged()

If true, only the staged ProductVariant is removed. If false, both the current and staged ProductVariant is removed.

Returns:

staged

setId

void setId(Long id)

The id of the ProductVariant to remove.

Parameters:

id - value to be set

setSku

void setSku(String sku)

The sku of the ProductVariant to remove.

Parameters:

sku - value to be set

setStaged

void setStaged(Boolean staged)

If true, only the staged ProductVariant is removed. If false, both the current and staged ProductVariant is removed.

Parameters:

staged - value to be set

of

static ProductRemoveVariantAction of()

factory method

Returns:

instance of ProductRemoveVariantAction

of

static ProductRemoveVariantAction of(ProductRemoveVariantAction template)

factory method to create a shallow copy ProductRemoveVariantAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductRemoveVariantAction deepCopy(@Nullable
 ProductRemoveVariantAction template)

factory method to create a deep copy of ProductRemoveVariantAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductRemoveVariantActionBuilder builder()

builder factory method for ProductRemoveVariantAction

Returns:

builder

builder

static ProductRemoveVariantActionBuilder builder(ProductRemoveVariantAction template)

create builder for ProductRemoveVariantAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductRemoveVariantAction

default <T> T withProductRemoveVariantAction(Function<ProductRemoveVariantAction,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<ProductRemoveVariantAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference