Package com.commercetools.api.models.message

Interface ProductPriceCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductPriceCustomFieldAddedMessagePayload
extends MessagePayload

Generated after adding a Custom Field to a Price using the Set Price CustomField update action.

Example to create an instance using the builder pattern

     ProductPriceCustomFieldAddedMessagePayload productPriceCustomFieldAddedMessagePayload = ProductPriceCustomFieldAddedMessagePayload.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_ADDED	discriminator value for ProductPriceCustomFieldAddedMessagePayload

Method Summary

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

static final String PRODUCT_PRICE_CUSTOM_FIELD_ADDED

discriminator value for ProductPriceCustomFieldAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getPriceId

@NotNull
@NotNull String getPriceId()

Unique identifier of the Price to which the Custom Field was added.

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

Returns:

name

getValue

@NotNull
@NotNull Object getValue()

The added CustomFieldValue based on the FieldType.

Returns:

value

setPriceId

void setPriceId(String priceId)

Unique identifier of the Price to which the Custom Field was added.

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

Parameters:

name - value to be set

setValue

void setValue(Object value)

The added CustomFieldValue based on the FieldType.

Parameters:

value - value to be set

of

static ProductPriceCustomFieldAddedMessagePayload of()

factory method

Returns:

instance of ProductPriceCustomFieldAddedMessagePayload

of

static ProductPriceCustomFieldAddedMessagePayload of(ProductPriceCustomFieldAddedMessagePayload template)

factory method to create a shallow copy ProductPriceCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPriceCustomFieldAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductPriceCustomFieldAddedMessagePayload deepCopy(@Nullable
 ProductPriceCustomFieldAddedMessagePayload template)

factory method to create a deep copy of ProductPriceCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for ProductPriceCustomFieldAddedMessagePayload

Returns:

builder

builder

static ProductPriceCustomFieldAddedMessagePayloadBuilder builder(ProductPriceCustomFieldAddedMessagePayload template)

create builder for ProductPriceCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceCustomFieldAddedMessagePayload

default <T> T withProductPriceCustomFieldAddedMessagePayload(Function<ProductPriceCustomFieldAddedMessagePayload,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<ProductPriceCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference