Package com.commercetools.api.models.product

Interface ProductRemoveAssetAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductRemoveAssetActionImpl

public interface ProductRemoveAssetAction
extends ProductUpdateAction

Either variantId or sku is required. The Asset to remove must be specified using either assetId or assetKey.

Example to create an instance using the builder pattern

     ProductRemoveAssetAction productRemoveAssetAction = ProductRemoveAssetAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_ASSET	discriminator value for ProductRemoveAssetAction

Method Summary

Modifier and Type	Method	Description
static ProductRemoveAssetActionBuilder	builder()	builder factory method for ProductRemoveAssetAction
static ProductRemoveAssetActionBuilder	builder(ProductRemoveAssetAction template)	create builder for ProductRemoveAssetAction instance
static ProductRemoveAssetAction	deepCopy(ProductRemoveAssetAction template)	factory method to create a deep copy of ProductRemoveAssetAction
String	getAssetId()	The id of the Asset to remove.
String	getAssetKey()	The key of the Asset to remove.
String	getSku()	The sku of the ProductVariant to update.
Boolean	getStaged()	If true, only the staged Asset is removed.
Long	getVariantId()	The id of the ProductVariant to update.
static ProductRemoveAssetAction	of()	factory method
static ProductRemoveAssetAction	of(ProductRemoveAssetAction template)	factory method to create a shallow copy ProductRemoveAssetAction
void	setAssetId(String assetId)	The id of the Asset to remove.
void	setAssetKey(String assetKey)	The key of the Asset to remove.
void	setSku(String sku)	The sku of the ProductVariant to update.
void	setStaged(Boolean staged)	If true, only the staged Asset is removed.
void	setVariantId(Long variantId)	The id of the ProductVariant to update.
static com.fasterxml.jackson.core.type.TypeReference<ProductRemoveAssetAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductRemoveAssetAction(Function<ProductRemoveAssetAction,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_ASSET

static final String REMOVE_ASSET

discriminator value for ProductRemoveAssetAction

See Also:

• Constant Field Values

Method Details

getVariantId

Long getVariantId()

The id of the ProductVariant to update.

Returns:

variantId

getSku

String getSku()

The sku of the ProductVariant to update.

Returns:

sku

getStaged

Boolean getStaged()

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

Returns:

staged

getAssetId

String getAssetId()

The id of the Asset to remove.

Returns:

assetId

getAssetKey

String getAssetKey()

The key of the Asset to remove.

Returns:

assetKey

setVariantId

void setVariantId(Long variantId)

The id of the ProductVariant to update.

Parameters:

variantId - value to be set

setSku

void setSku(String sku)

The sku of the ProductVariant to update.

Parameters:

sku - value to be set

setStaged

void setStaged(Boolean staged)

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

Parameters:

staged - value to be set

setAssetId

void setAssetId(String assetId)

The id of the Asset to remove.

Parameters:

assetId - value to be set

setAssetKey

void setAssetKey(String assetKey)

The key of the Asset to remove.

Parameters:

assetKey - value to be set

of

static ProductRemoveAssetAction of()

factory method

Returns:

instance of ProductRemoveAssetAction

of

static ProductRemoveAssetAction of(ProductRemoveAssetAction template)

factory method to create a shallow copy ProductRemoveAssetAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductRemoveAssetAction deepCopy(@Nullable
 ProductRemoveAssetAction template)

factory method to create a deep copy of ProductRemoveAssetAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductRemoveAssetActionBuilder builder()

builder factory method for ProductRemoveAssetAction

Returns:

builder

builder

static ProductRemoveAssetActionBuilder builder(ProductRemoveAssetAction template)

create builder for ProductRemoveAssetAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductRemoveAssetAction

default <T> T withProductRemoveAssetAction(Function<ProductRemoveAssetAction,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<ProductRemoveAssetAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference