Package com.commercetools.api.models.product

Interface ProductSetImageLabelAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductSetImageLabelActionImpl

public interface ProductSetImageLabelAction
extends ProductUpdateAction

Either variantId or sku is required.

Example to create an instance using the builder pattern

     ProductSetImageLabelAction productSetImageLabelAction = ProductSetImageLabelAction.builder()
             .imageUrl("{imageUrl}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_IMAGE_LABEL	discriminator value for ProductSetImageLabelAction

Method Summary

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

SET_IMAGE_LABEL

static final String SET_IMAGE_LABEL

discriminator value for ProductSetImageLabelAction

See Also:

• Constant Field Values

Method Details

getSku

String getSku()

The sku of the ProductVariant to update.

Returns:

sku

getVariantId

Long getVariantId()

The id of the ProductVariant to update.

Returns:

variantId

getImageUrl

@NotNull
@NotNull String getImageUrl()

The URL of the image to set the label.

Returns:

imageUrl

getLabel

String getLabel()

Value to set. If empty, any existing value will be removed.

Returns:

label

getStaged

Boolean getStaged()

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

Returns:

staged

setSku

void setSku(String sku)

The sku of the ProductVariant to update.

Parameters:

sku - value to be set

setVariantId

void setVariantId(Long variantId)

The id of the ProductVariant to update.

Parameters:

variantId - value to be set

setImageUrl

void setImageUrl(String imageUrl)

The URL of the image to set the label.

Parameters:

imageUrl - value to be set

setLabel

void setLabel(String label)

Value to set. If empty, any existing value will be removed.

Parameters:

label - value to be set

setStaged

void setStaged(Boolean staged)

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

Parameters:

staged - value to be set

of

static ProductSetImageLabelAction of()

factory method

Returns:

instance of ProductSetImageLabelAction

of

static ProductSetImageLabelAction of(ProductSetImageLabelAction template)

factory method to create a shallow copy ProductSetImageLabelAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductSetImageLabelAction deepCopy(@Nullable
 ProductSetImageLabelAction template)

factory method to create a deep copy of ProductSetImageLabelAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSetImageLabelActionBuilder builder()

builder factory method for ProductSetImageLabelAction

Returns:

builder

builder

static ProductSetImageLabelActionBuilder builder(ProductSetImageLabelAction template)

create builder for ProductSetImageLabelAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSetImageLabelAction

default <T> T withProductSetImageLabelAction(Function<ProductSetImageLabelAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ProductSetImageLabelAction ofUnset(Long variantId,
 String imageUrl,
 Boolean staged)

ofUnsetStaged

static ProductSetImageLabelAction ofUnsetStaged(Long variantId,
 String imageUrl)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ProductSetImageLabelAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference