Package com.commercetools.api.models.product

Interface ProductAddExternalImageAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductAddExternalImageActionImpl

public interface ProductAddExternalImageAction
extends ProductUpdateAction

Either variantId or sku is required. Produces the ProductImageAdded Message.

Example to create an instance using the builder pattern

     ProductAddExternalImageAction productAddExternalImageAction = ProductAddExternalImageAction.builder()
             .image(imageBuilder -> imageBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_EXTERNAL_IMAGE	discriminator value for ProductAddExternalImageAction

Method Summary

Modifier and Type	Method	Description
static ProductAddExternalImageActionBuilder	builder()	builder factory method for ProductAddExternalImageAction
static ProductAddExternalImageActionBuilder	builder(ProductAddExternalImageAction template)	create builder for ProductAddExternalImageAction instance
static ProductAddExternalImageAction	deepCopy(ProductAddExternalImageAction template)	factory method to create a deep copy of ProductAddExternalImageAction
@NotNull @Valid Image	getImage()	Value to add to images.
String	getSku()	The sku of the ProductVariant to update.
Boolean	getStaged()	If true, only the staged images is updated.
Long	getVariantId()	The id of the ProductVariant to update.
static ProductAddExternalImageAction	of()	factory method
static ProductAddExternalImageAction	of(ProductAddExternalImageAction template)	factory method to create a shallow copy ProductAddExternalImageAction
void	setImage(Image image)	Value to add to images.
void	setSku(String sku)	The sku of the ProductVariant to update.
void	setStaged(Boolean staged)	If true, only the staged images is updated.
void	setVariantId(Long variantId)	The id of the ProductVariant to update.
static com.fasterxml.jackson.core.type.TypeReference<ProductAddExternalImageAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductAddExternalImageAction(Function<ProductAddExternalImageAction,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

ADD_EXTERNAL_IMAGE

static final String ADD_EXTERNAL_IMAGE

discriminator value for ProductAddExternalImageAction

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

getImage

@NotNull
@Valid
@NotNull @Valid Image getImage()

Value to add to images.

Returns:

image

getStaged

Boolean getStaged()

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

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

setImage

void setImage(Image image)

Value to add to images.

Parameters:

image - value to be set

setStaged

void setStaged(Boolean staged)

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

Parameters:

staged - value to be set

of

static ProductAddExternalImageAction of()

factory method

Returns:

instance of ProductAddExternalImageAction

of

static ProductAddExternalImageAction of(ProductAddExternalImageAction template)

factory method to create a shallow copy ProductAddExternalImageAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductAddExternalImageAction deepCopy(@Nullable
 ProductAddExternalImageAction template)

factory method to create a deep copy of ProductAddExternalImageAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductAddExternalImageActionBuilder builder()

builder factory method for ProductAddExternalImageAction

Returns:

builder

builder

static ProductAddExternalImageActionBuilder builder(ProductAddExternalImageAction template)

create builder for ProductAddExternalImageAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductAddExternalImageAction

default <T> T withProductAddExternalImageAction(Function<ProductAddExternalImageAction,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<ProductAddExternalImageAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference