Package com.commercetools.api.models.message

Interface ProductImageAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductImageAddedMessagePayload
extends MessagePayload

Generated after a successful Add External Image update action or after the successful upload of an image.

Example to create an instance using the builder pattern

     ProductImageAddedMessagePayload productImageAddedMessagePayload = ProductImageAddedMessagePayload.builder()
             .variantId(0.3)
             .image(imageBuilder -> imageBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_IMAGE_ADDED	discriminator value for ProductImageAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductImageAddedMessagePayloadBuilder	builder()	builder factory method for ProductImageAddedMessagePayload
static ProductImageAddedMessagePayloadBuilder	builder(ProductImageAddedMessagePayload template)	create builder for ProductImageAddedMessagePayload instance
ProductImageAddedMessagePayload	copyDeep()
static ProductImageAddedMessagePayload	deepCopy(ProductImageAddedMessagePayload template)	factory method to create a deep copy of ProductImageAddedMessagePayload
@NotNull @Valid Image	getImage()	Image that was added.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Product Projection.
@NotNull Long	getVariantId()	Unique identifier of the Product Variant to which the Image was added.
static ProductImageAddedMessagePayload	of()	factory method
static ProductImageAddedMessagePayload	of(ProductImageAddedMessagePayload template)	factory method to create a shallow copy ProductImageAddedMessagePayload
void	setImage(Image image)	Image that was added.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Product Projection.
void	setVariantId(Long variantId)	Unique identifier of the Product Variant to which the Image was added.
static com.fasterxml.jackson.core.type.TypeReference<ProductImageAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductImageAddedMessagePayload(Function<ProductImageAddedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

PRODUCT_IMAGE_ADDED

static final String PRODUCT_IMAGE_ADDED

discriminator value for ProductImageAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getVariantId

@NotNull
@NotNull Long getVariantId()

Unique identifier of the Product Variant to which the Image was added.

Returns:

variantId

getImage

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

Image that was added.

Returns:

image

getStaged

@NotNull
@NotNull Boolean getStaged()

Whether the update was only applied to the staged Product Projection.

Returns:

staged

setVariantId

void setVariantId(Long variantId)

Unique identifier of the Product Variant to which the Image was added.

Parameters:

variantId - value to be set

setImage

void setImage(Image image)

Image that was added.

Parameters:

image - value to be set

setStaged

void setStaged(Boolean staged)

Whether the update was only applied to the staged Product Projection.

Parameters:

staged - value to be set

of

static ProductImageAddedMessagePayload of()

factory method

Returns:

instance of ProductImageAddedMessagePayload

of

static ProductImageAddedMessagePayload of(ProductImageAddedMessagePayload template)

factory method to create a shallow copy ProductImageAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductImageAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductImageAddedMessagePayload deepCopy(@Nullable
 ProductImageAddedMessagePayload template)

factory method to create a deep copy of ProductImageAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductImageAddedMessagePayloadBuilder builder()

builder factory method for ProductImageAddedMessagePayload

Returns:

builder

builder

static ProductImageAddedMessagePayloadBuilder builder(ProductImageAddedMessagePayload template)

create builder for ProductImageAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductImageAddedMessagePayload

default <T> T withProductImageAddedMessagePayload(Function<ProductImageAddedMessagePayload,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<ProductImageAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference