Package com.commercetools.api.models.message

Interface ProductPriceRemovedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductPriceRemovedMessagePayload
extends MessagePayload

Generated after a successful Remove Price update action.

Example to create an instance using the builder pattern

     ProductPriceRemovedMessagePayload productPriceRemovedMessagePayload = ProductPriceRemovedMessagePayload.builder()
             .variantId(0.3)
             .price(priceBuilder -> priceBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_PRICE_REMOVED	discriminator value for ProductPriceRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductPriceRemovedMessagePayloadBuilder	builder()	builder factory method for ProductPriceRemovedMessagePayload
static ProductPriceRemovedMessagePayloadBuilder	builder(ProductPriceRemovedMessagePayload template)	create builder for ProductPriceRemovedMessagePayload instance
ProductPriceRemovedMessagePayload	copyDeep()
static ProductPriceRemovedMessagePayload	deepCopy(ProductPriceRemovedMessagePayload template)	factory method to create a deep copy of ProductPriceRemovedMessagePayload
@NotNull @Valid Price	getPrice()	The Embedded Price that was removed from the ProductVariant.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Product Projection.
@NotNull Long	getVariantId()	Unique identifier of the ProductVariant for which the Price was removed.
static ProductPriceRemovedMessagePayload	of()	factory method
static ProductPriceRemovedMessagePayload	of(ProductPriceRemovedMessagePayload template)	factory method to create a shallow copy ProductPriceRemovedMessagePayload
void	setPrice(Price price)	The Embedded Price that was removed from the ProductVariant.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Product Projection.
void	setVariantId(Long variantId)	Unique identifier of the ProductVariant for which the Price was removed.
static com.fasterxml.jackson.core.type.TypeReference<ProductPriceRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPriceRemovedMessagePayload(Function<ProductPriceRemovedMessagePayload,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_PRICE_REMOVED

static final String PRODUCT_PRICE_REMOVED

discriminator value for ProductPriceRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getVariantId

@NotNull
@NotNull Long getVariantId()

Unique identifier of the ProductVariant for which the Price was removed.

Returns:

variantId

getPrice

@NotNull
@Valid
@NotNull @Valid Price getPrice()

The Embedded Price that was removed from the ProductVariant.

Returns:

price

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 ProductVariant for which the Price was removed.

Parameters:

variantId - value to be set

setPrice

void setPrice(Price price)

The Embedded Price that was removed from the ProductVariant.

Parameters:

price - 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 ProductPriceRemovedMessagePayload of()

factory method

Returns:

instance of ProductPriceRemovedMessagePayload

of

static ProductPriceRemovedMessagePayload of(ProductPriceRemovedMessagePayload template)

factory method to create a shallow copy ProductPriceRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPriceRemovedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductPriceRemovedMessagePayload deepCopy(@Nullable
 ProductPriceRemovedMessagePayload template)

factory method to create a deep copy of ProductPriceRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceRemovedMessagePayloadBuilder builder()

builder factory method for ProductPriceRemovedMessagePayload

Returns:

builder

builder

static ProductPriceRemovedMessagePayloadBuilder builder(ProductPriceRemovedMessagePayload template)

create builder for ProductPriceRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceRemovedMessagePayload

default <T> T withProductPriceRemovedMessagePayload(Function<ProductPriceRemovedMessagePayload,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<ProductPriceRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference