Package com.commercetools.api.models.message

Interface ProductDeletedMessagePayload

All Superinterfaces:

MessagePayload

All Known Implementing Classes:

ProductDeletedMessagePayloadImpl

public interface ProductDeletedMessagePayload
extends MessagePayload

Generated after a successful Delete Product request.

Example to create an instance using the builder pattern

     ProductDeletedMessagePayload productDeletedMessagePayload = ProductDeletedMessagePayload.builder()
             .plusRemovedImageUrls(removedImageUrlsBuilder -> removedImageUrlsBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_DELETED	discriminator value for ProductDeletedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductDeletedMessagePayloadBuilder	builder()	builder factory method for ProductDeletedMessagePayload
static ProductDeletedMessagePayloadBuilder	builder(ProductDeletedMessagePayload template)	create builder for ProductDeletedMessagePayload instance
static ProductDeletedMessagePayload	deepCopy(ProductDeletedMessagePayload template)	factory method to create a deep copy of ProductDeletedMessagePayload
@Valid ProductProjection	getCurrentProjection()	Current Product Projection of the deleted Product.
@NotNull List<String>	getRemovedImageUrls()	List of image URLs that were removed during the Delete Product request.
static ProductDeletedMessagePayload	of()	factory method
static ProductDeletedMessagePayload	of(ProductDeletedMessagePayload template)	factory method to create a shallow copy ProductDeletedMessagePayload
void	setCurrentProjection(ProductProjection currentProjection)	Current Product Projection of the deleted Product.
void	setRemovedImageUrls(String... removedImageUrls)	List of image URLs that were removed during the Delete Product request.
void	setRemovedImageUrls(List<String> removedImageUrls)	List of image URLs that were removed during the Delete Product request.
static com.fasterxml.jackson.core.type.TypeReference<ProductDeletedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductDeletedMessagePayload(Function<ProductDeletedMessagePayload,T> helper)	accessor map function

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

getType, withMessagePayload

Field Details

PRODUCT_DELETED

static final String PRODUCT_DELETED

discriminator value for ProductDeletedMessagePayload

See Also:

• Constant Field Values

Method Details

getRemovedImageUrls

@NotNull
@NotNull List<String> getRemovedImageUrls()

List of image URLs that were removed during the Delete Product request.

Returns:

removedImageUrls

getCurrentProjection

@Valid
@Valid ProductProjection getCurrentProjection()

Current Product Projection of the deleted Product.

Returns:

currentProjection

setRemovedImageUrls

void setRemovedImageUrls(String... removedImageUrls)

List of image URLs that were removed during the Delete Product request.

Parameters:

removedImageUrls - values to be set

setRemovedImageUrls

void setRemovedImageUrls(List<String> removedImageUrls)

List of image URLs that were removed during the Delete Product request.

Parameters:

removedImageUrls - values to be set

setCurrentProjection

void setCurrentProjection(ProductProjection currentProjection)

Current Product Projection of the deleted Product.

Parameters:

currentProjection - value to be set

of

static ProductDeletedMessagePayload of()

factory method

Returns:

instance of ProductDeletedMessagePayload

of

static ProductDeletedMessagePayload of(ProductDeletedMessagePayload template)

factory method to create a shallow copy ProductDeletedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductDeletedMessagePayload deepCopy(@Nullable
 ProductDeletedMessagePayload template)

factory method to create a deep copy of ProductDeletedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductDeletedMessagePayloadBuilder builder()

builder factory method for ProductDeletedMessagePayload

Returns:

builder

builder

static ProductDeletedMessagePayloadBuilder builder(ProductDeletedMessagePayload template)

create builder for ProductDeletedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductDeletedMessagePayload

default <T> T withProductDeletedMessagePayload(Function<ProductDeletedMessagePayload,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<ProductDeletedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference