Package com.commercetools.api.models.message

Interface ProductPriceAddedMessagePayload

All Superinterfaces:

MessagePayload

All Known Implementing Classes:

ProductPriceAddedMessagePayloadImpl

public interface ProductPriceAddedMessagePayload
extends MessagePayload

Generated after a successful Add Price update action.

Example to create an instance using the builder pattern

     ProductPriceAddedMessagePayload productPriceAddedMessagePayload = ProductPriceAddedMessagePayload.builder()
             .variantId(0.3)
             .price(priceBuilder -> priceBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_PRICE_ADDED	discriminator value for ProductPriceAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductPriceAddedMessagePayloadBuilder	builder()	builder factory method for ProductPriceAddedMessagePayload
static ProductPriceAddedMessagePayloadBuilder	builder(ProductPriceAddedMessagePayload template)	create builder for ProductPriceAddedMessagePayload instance
static ProductPriceAddedMessagePayload	deepCopy(ProductPriceAddedMessagePayload template)	factory method to create a deep copy of ProductPriceAddedMessagePayload
@NotNull @Valid Price	getPrice()	The Embedded Price that was added to 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 added.
static ProductPriceAddedMessagePayload	of()	factory method
static ProductPriceAddedMessagePayload	of(ProductPriceAddedMessagePayload template)	factory method to create a shallow copy ProductPriceAddedMessagePayload
void	setPrice(Price price)	The Embedded Price that was added to 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 added.
static com.fasterxml.jackson.core.type.TypeReference<ProductPriceAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPriceAddedMessagePayload(Function<ProductPriceAddedMessagePayload,T> helper)	accessor map function

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

getType, withMessagePayload

Field Details

PRODUCT_PRICE_ADDED

static final String PRODUCT_PRICE_ADDED

discriminator value for ProductPriceAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getVariantId

@NotNull
@NotNull Long getVariantId()

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

Returns:

variantId

getPrice

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

The Embedded Price that was added to 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 added.

Parameters:

variantId - value to be set

setPrice

void setPrice(Price price)

The Embedded Price that was added to 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 ProductPriceAddedMessagePayload of()

factory method

Returns:

instance of ProductPriceAddedMessagePayload

of

static ProductPriceAddedMessagePayload of(ProductPriceAddedMessagePayload template)

factory method to create a shallow copy ProductPriceAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductPriceAddedMessagePayload deepCopy(@Nullable
 ProductPriceAddedMessagePayload template)

factory method to create a deep copy of ProductPriceAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceAddedMessagePayloadBuilder builder()

builder factory method for ProductPriceAddedMessagePayload

Returns:

builder

builder

static ProductPriceAddedMessagePayloadBuilder builder(ProductPriceAddedMessagePayload template)

create builder for ProductPriceAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceAddedMessagePayload

default <T> T withProductPriceAddedMessagePayload(Function<ProductPriceAddedMessagePayload,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<ProductPriceAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference