Package com.commercetools.api.models.message

Interface ProductPriceCustomFieldChangedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductPriceCustomFieldChangedMessagePayload
extends MessagePayload

Generated after changing an existing Custom Field on a Price using the Set Price CustomField update action.

Example to create an instance using the builder pattern

     ProductPriceCustomFieldChangedMessagePayload productPriceCustomFieldChangedMessagePayload = ProductPriceCustomFieldChangedMessagePayload.builder()
             .priceId("{priceId}")
             .variantId(0.3)
             .staged(true)
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_PRICE_CUSTOM_FIELD_CHANGED	discriminator value for ProductPriceCustomFieldChangedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductPriceCustomFieldChangedMessagePayloadBuilder	builder()	builder factory method for ProductPriceCustomFieldChangedMessagePayload
static ProductPriceCustomFieldChangedMessagePayloadBuilder	builder(ProductPriceCustomFieldChangedMessagePayload template)	create builder for ProductPriceCustomFieldChangedMessagePayload instance
ProductPriceCustomFieldChangedMessagePayload	copyDeep()
static ProductPriceCustomFieldChangedMessagePayload	deepCopy(ProductPriceCustomFieldChangedMessagePayload template)	factory method to create a deep copy of ProductPriceCustomFieldChangedMessagePayload
@NotNull String	getName()	Name of the Custom Field that was changed.
@NotNull String	getPriceId()	Unique identifier of the Price of which the Custom Field was changed.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Product Projection.
@NotNull Object	getValue()	CustomFieldValue based on the FieldType after the Set Price CustomField update action.
@NotNull Long	getVariantId()	Unique identifier of the ProductVariant to which the Price belongs.
static ProductPriceCustomFieldChangedMessagePayload	of()	factory method
static ProductPriceCustomFieldChangedMessagePayload	of(ProductPriceCustomFieldChangedMessagePayload template)	factory method to create a shallow copy ProductPriceCustomFieldChangedMessagePayload
void	setName(String name)	Name of the Custom Field that was changed.
void	setPriceId(String priceId)	Unique identifier of the Price of which the Custom Field was changed.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Product Projection.
void	setValue(Object value)	CustomFieldValue based on the FieldType after the Set Price CustomField update action.
void	setVariantId(Long variantId)	Unique identifier of the ProductVariant to which the Price belongs.
static com.fasterxml.jackson.core.type.TypeReference<ProductPriceCustomFieldChangedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPriceCustomFieldChangedMessagePayload(Function<ProductPriceCustomFieldChangedMessagePayload,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_CUSTOM_FIELD_CHANGED

static final String PRODUCT_PRICE_CUSTOM_FIELD_CHANGED

discriminator value for ProductPriceCustomFieldChangedMessagePayload

See Also:

• Constant Field Values

Method Details

getPriceId

@NotNull
@NotNull String getPriceId()

Unique identifier of the Price of which the Custom Field was changed.

Returns:

priceId

getVariantId

@NotNull
@NotNull Long getVariantId()

Unique identifier of the ProductVariant to which the Price belongs.

Returns:

variantId

getStaged

@NotNull
@NotNull Boolean getStaged()

Whether the update was only applied to the staged Product Projection.

Returns:

staged

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that was changed.

Returns:

name

getValue

@NotNull
@NotNull Object getValue()

CustomFieldValue based on the FieldType after the Set Price CustomField update action.

Returns:

value

setPriceId

void setPriceId(String priceId)

Unique identifier of the Price of which the Custom Field was changed.

Parameters:

priceId - value to be set

setVariantId

void setVariantId(Long variantId)

Unique identifier of the ProductVariant to which the Price belongs.

Parameters:

variantId - 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

setName

void setName(String name)

Name of the Custom Field that was changed.

Parameters:

name - value to be set

setValue

void setValue(Object value)

CustomFieldValue based on the FieldType after the Set Price CustomField update action.

Parameters:

value - value to be set

of

static ProductPriceCustomFieldChangedMessagePayload of()

factory method

Returns:

instance of ProductPriceCustomFieldChangedMessagePayload

of

static ProductPriceCustomFieldChangedMessagePayload of(ProductPriceCustomFieldChangedMessagePayload template)

factory method to create a shallow copy ProductPriceCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPriceCustomFieldChangedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductPriceCustomFieldChangedMessagePayload deepCopy(@Nullable
 ProductPriceCustomFieldChangedMessagePayload template)

factory method to create a deep copy of ProductPriceCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceCustomFieldChangedMessagePayloadBuilder builder()

builder factory method for ProductPriceCustomFieldChangedMessagePayload

Returns:

builder

builder

static ProductPriceCustomFieldChangedMessagePayloadBuilder builder(ProductPriceCustomFieldChangedMessagePayload template)

create builder for ProductPriceCustomFieldChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceCustomFieldChangedMessagePayload

default <T> T withProductPriceCustomFieldChangedMessagePayload(Function<ProductPriceCustomFieldChangedMessagePayload,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<ProductPriceCustomFieldChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference