Package com.commercetools.api.models.message

Interface ProductPricesSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductPricesSetMessagePayload
extends MessagePayload

Generated after a successful Set Prices update action.

Example to create an instance using the builder pattern

     ProductPricesSetMessagePayload productPricesSetMessagePayload = ProductPricesSetMessagePayload.builder()
             .variantId(0.3)
             .plusPrices(pricesBuilder -> pricesBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_PRICES_SET	discriminator value for ProductPricesSetMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductPricesSetMessagePayloadBuilder	builder()	builder factory method for ProductPricesSetMessagePayload
static ProductPricesSetMessagePayloadBuilder	builder(ProductPricesSetMessagePayload template)	create builder for ProductPricesSetMessagePayload instance
ProductPricesSetMessagePayload	copyDeep()
static ProductPricesSetMessagePayload	deepCopy(ProductPricesSetMessagePayload template)	factory method to create a deep copy of ProductPricesSetMessagePayload
@NotNull @Valid List<Price>	getPrices()	The Embedded Prices that were set on 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 set.
static ProductPricesSetMessagePayload	of()	factory method
static ProductPricesSetMessagePayload	of(ProductPricesSetMessagePayload template)	factory method to create a shallow copy ProductPricesSetMessagePayload
void	setPrices(Price... prices)	The Embedded Prices that were set on the ProductVariant.
void	setPrices(List<Price> prices)	The Embedded Prices that were set on 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 set.
static com.fasterxml.jackson.core.type.TypeReference<ProductPricesSetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPricesSetMessagePayload(Function<ProductPricesSetMessagePayload,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_PRICES_SET

static final String PRODUCT_PRICES_SET

discriminator value for ProductPricesSetMessagePayload

See Also:

• Constant Field Values

Method Details

getVariantId

@NotNull
@NotNull Long getVariantId()

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

Returns:

variantId

getPrices

@NotNull
@Valid
@NotNull @Valid List<Price> getPrices()

The Embedded Prices that were set on the ProductVariant.

Returns:

prices

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 set.

Parameters:

variantId - value to be set

setPrices

void setPrices(Price... prices)

The Embedded Prices that were set on the ProductVariant.

Parameters:

prices - values to be set

setPrices

void setPrices(List<Price> prices)

The Embedded Prices that were set on the ProductVariant.

Parameters:

prices - values 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 ProductPricesSetMessagePayload of()

factory method

Returns:

instance of ProductPricesSetMessagePayload

of

static ProductPricesSetMessagePayload of(ProductPricesSetMessagePayload template)

factory method to create a shallow copy ProductPricesSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPricesSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductPricesSetMessagePayload deepCopy(@Nullable
 ProductPricesSetMessagePayload template)

factory method to create a deep copy of ProductPricesSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPricesSetMessagePayloadBuilder builder()

builder factory method for ProductPricesSetMessagePayload

Returns:

builder

builder

static ProductPricesSetMessagePayloadBuilder builder(ProductPricesSetMessagePayload template)

create builder for ProductPricesSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPricesSetMessagePayload

default <T> T withProductPricesSetMessagePayload(Function<ProductPricesSetMessagePayload,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<ProductPricesSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference