Package com.commercetools.api.models.message

Interface ProductTailoringImageAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductTailoringImageAddedMessagePayload
extends MessagePayload

Generated after a successful Add External Image update action or after a successful Upload Product Tailoring image request.

Example to create an instance using the builder pattern

     ProductTailoringImageAddedMessagePayload productTailoringImageAddedMessagePayload = ProductTailoringImageAddedMessagePayload.builder()
             .store(storeBuilder -> storeBuilder)
             .product(productBuilder -> productBuilder)
             .variantId(0.3)
             .image(imageBuilder -> imageBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_TAILORING_IMAGE_ADDED	discriminator value for ProductTailoringImageAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductTailoringImageAddedMessagePayloadBuilder	builder()	builder factory method for ProductTailoringImageAddedMessagePayload
static ProductTailoringImageAddedMessagePayloadBuilder	builder(ProductTailoringImageAddedMessagePayload template)	create builder for ProductTailoringImageAddedMessagePayload instance
ProductTailoringImageAddedMessagePayload	copyDeep()
static ProductTailoringImageAddedMessagePayload	deepCopy(ProductTailoringImageAddedMessagePayload template)	factory method to create a deep copy of ProductTailoringImageAddedMessagePayload
@NotNull @Valid Image	getImage()	Image that was added.
@NotNull @Valid ProductReference	getProduct()	Reference to the tailored Product.
String	getProductKey()	key of the tailored Product.
@NotNull @Valid StoreKeyReference	getStore()	The Store to which the Product Tailoring belongs.
@NotNull Long	getVariantId()	id of the tailored ProductVariant.
static ProductTailoringImageAddedMessagePayload	of()	factory method
static ProductTailoringImageAddedMessagePayload	of(ProductTailoringImageAddedMessagePayload template)	factory method to create a shallow copy ProductTailoringImageAddedMessagePayload
void	setImage(Image image)	Image that was added.
void	setProduct(ProductReference product)	Reference to the tailored Product.
void	setProductKey(String productKey)	key of the tailored Product.
void	setStore(StoreKeyReference store)	The Store to which the Product Tailoring belongs.
void	setVariantId(Long variantId)	id of the tailored ProductVariant.
static com.fasterxml.jackson.core.type.TypeReference<ProductTailoringImageAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductTailoringImageAddedMessagePayload(Function<ProductTailoringImageAddedMessagePayload,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_TAILORING_IMAGE_ADDED

static final String PRODUCT_TAILORING_IMAGE_ADDED

discriminator value for ProductTailoringImageAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getStore

@NotNull
@Valid
@NotNull @Valid StoreKeyReference getStore()

The Store to which the Product Tailoring belongs.

Returns:

store

getProductKey

String getProductKey()

key of the tailored Product.

Returns:

productKey

getProduct

@NotNull
@Valid
@NotNull @Valid ProductReference getProduct()

Reference to the tailored Product.

Returns:

product

getVariantId

@NotNull
@NotNull Long getVariantId()

id of the tailored ProductVariant.

Returns:

variantId

getImage

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

Image that was added.

Returns:

image

setStore

void setStore(StoreKeyReference store)

The Store to which the Product Tailoring belongs.

Parameters:

store - value to be set

setProductKey

void setProductKey(String productKey)

key of the tailored Product.

Parameters:

productKey - value to be set

setProduct

void setProduct(ProductReference product)

Reference to the tailored Product.

Parameters:

product - value to be set

setVariantId

void setVariantId(Long variantId)

id of the tailored ProductVariant.

Parameters:

variantId - value to be set

setImage

void setImage(Image image)

Image that was added.

Parameters:

image - value to be set

of

static ProductTailoringImageAddedMessagePayload of()

factory method

Returns:

instance of ProductTailoringImageAddedMessagePayload

of

static ProductTailoringImageAddedMessagePayload of(ProductTailoringImageAddedMessagePayload template)

factory method to create a shallow copy ProductTailoringImageAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductTailoringImageAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductTailoringImageAddedMessagePayload deepCopy(@Nullable
 ProductTailoringImageAddedMessagePayload template)

factory method to create a deep copy of ProductTailoringImageAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductTailoringImageAddedMessagePayloadBuilder builder()

builder factory method for ProductTailoringImageAddedMessagePayload

Returns:

builder

builder

static ProductTailoringImageAddedMessagePayloadBuilder builder(ProductTailoringImageAddedMessagePayload template)

create builder for ProductTailoringImageAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductTailoringImageAddedMessagePayload

default <T> T withProductTailoringImageAddedMessagePayload(Function<ProductTailoringImageAddedMessagePayload,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<ProductTailoringImageAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference