Package com.commercetools.api.models.product

Interface ProductRemoveImageAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductRemoveImageActionImpl

public interface ProductRemoveImageAction
extends ProductUpdateAction

Removes a Product image and deletes it from the Content Delivery Network (external images are not deleted). Deletion from the CDN is not instant, which means the image file itself will stay available for some time after the deletion. Either variantId or sku is required.

Example to create an instance using the builder pattern

     ProductRemoveImageAction productRemoveImageAction = ProductRemoveImageAction.builder()
             .imageUrl("{imageUrl}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_IMAGE	discriminator value for ProductRemoveImageAction

Method Summary

Modifier and Type	Method	Description
static ProductRemoveImageActionBuilder	builder()	builder factory method for ProductRemoveImageAction
static ProductRemoveImageActionBuilder	builder(ProductRemoveImageAction template)	create builder for ProductRemoveImageAction instance
static ProductRemoveImageAction	deepCopy(ProductRemoveImageAction template)	factory method to create a deep copy of ProductRemoveImageAction
@NotNull String	getImageUrl()	The URL of the image to remove.
String	getSku()	The sku of the ProductVariant to update.
Boolean	getStaged()	If true, only the staged image is removed.
Long	getVariantId()	The id of the ProductVariant to update.
static ProductRemoveImageAction	of()	factory method
static ProductRemoveImageAction	of(ProductRemoveImageAction template)	factory method to create a shallow copy ProductRemoveImageAction
void	setImageUrl(String imageUrl)	The URL of the image to remove.
void	setSku(String sku)	The sku of the ProductVariant to update.
void	setStaged(Boolean staged)	If true, only the staged image is removed.
void	setVariantId(Long variantId)	The id of the ProductVariant to update.
static com.fasterxml.jackson.core.type.TypeReference<ProductRemoveImageAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductRemoveImageAction(Function<ProductRemoveImageAction,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_IMAGE

static final String REMOVE_IMAGE

discriminator value for ProductRemoveImageAction

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

getImageUrl

@NotNull
@NotNull String getImageUrl()

The URL of the image to remove.

Returns:

imageUrl

getStaged

Boolean getStaged()

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

Returns:

staged

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

setImageUrl

void setImageUrl(String imageUrl)

The URL of the image to remove.

Parameters:

imageUrl - value to be set

setStaged

void setStaged(Boolean staged)

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

Parameters:

staged - value to be set

of

static ProductRemoveImageAction of()

factory method

Returns:

instance of ProductRemoveImageAction

of

static ProductRemoveImageAction of(ProductRemoveImageAction template)

factory method to create a shallow copy ProductRemoveImageAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductRemoveImageAction deepCopy(@Nullable
 ProductRemoveImageAction template)

factory method to create a deep copy of ProductRemoveImageAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductRemoveImageActionBuilder builder()

builder factory method for ProductRemoveImageAction

Returns:

builder

builder

static ProductRemoveImageActionBuilder builder(ProductRemoveImageAction template)

create builder for ProductRemoveImageAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductRemoveImageAction

default <T> T withProductRemoveImageAction(Function<ProductRemoveImageAction,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<ProductRemoveImageAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference