Package com.commercetools.api.models.message

Interface ProductPriceCustomFieldsSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductPriceCustomFieldsSetMessagePayload
extends MessagePayload

Generated after a successful Set Price Custom Type update action.

Example to create an instance using the builder pattern

     ProductPriceCustomFieldsSetMessagePayload productPriceCustomFieldsSetMessagePayload = ProductPriceCustomFieldsSetMessagePayload.builder()
             .priceId("{priceId}")
             .variantId(0.3)
             .staged(true)
             .customField(customFieldBuilder -> customFieldBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_PRICE_CUSTOM_FIELDS_SET	discriminator value for ProductPriceCustomFieldsSetMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductPriceCustomFieldsSetMessagePayloadBuilder	builder()	builder factory method for ProductPriceCustomFieldsSetMessagePayload
static ProductPriceCustomFieldsSetMessagePayloadBuilder	builder(ProductPriceCustomFieldsSetMessagePayload template)	create builder for ProductPriceCustomFieldsSetMessagePayload instance
ProductPriceCustomFieldsSetMessagePayload	copyDeep()
static ProductPriceCustomFieldsSetMessagePayload	deepCopy(ProductPriceCustomFieldsSetMessagePayload template)	factory method to create a deep copy of ProductPriceCustomFieldsSetMessagePayload
@NotNull @Valid CustomFields	getCustomField()	Custom Fields that were set.
String	getOldTypeId()	id of the previous Custom Type.
@NotNull String	getPriceId()	Unique identifier of the Price on which the Custom Type was set.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Product Projection.
@NotNull Long	getVariantId()	Unique identifier of the ProductVariant to which the Price belongs.
static ProductPriceCustomFieldsSetMessagePayload	of()	factory method
static ProductPriceCustomFieldsSetMessagePayload	of(ProductPriceCustomFieldsSetMessagePayload template)	factory method to create a shallow copy ProductPriceCustomFieldsSetMessagePayload
void	setCustomField(CustomFields customField)	Custom Fields that were set.
void	setOldTypeId(String oldTypeId)	id of the previous Custom Type.
void	setPriceId(String priceId)	Unique identifier of the Price on which the Custom Type was set.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Product Projection.
void	setVariantId(Long variantId)	Unique identifier of the ProductVariant to which the Price belongs.
static com.fasterxml.jackson.core.type.TypeReference<ProductPriceCustomFieldsSetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPriceCustomFieldsSetMessagePayload(Function<ProductPriceCustomFieldsSetMessagePayload,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_FIELDS_SET

static final String PRODUCT_PRICE_CUSTOM_FIELDS_SET

discriminator value for ProductPriceCustomFieldsSetMessagePayload

See Also:

• Constant Field Values

Method Details

getPriceId

@NotNull
@NotNull String getPriceId()

Unique identifier of the Price on which the Custom Type was set.

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

getCustomField

@NotNull
@Valid
@NotNull @Valid CustomFields getCustomField()

Custom Fields that were set.

Returns:

customField

getOldTypeId

String getOldTypeId()

id of the previous Custom Type. Absent if there was no previous Custom Type present.

Returns:

oldTypeId

setPriceId

void setPriceId(String priceId)

Unique identifier of the Price on which the Custom Type was set.

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

setCustomField

void setCustomField(CustomFields customField)

Custom Fields that were set.

Parameters:

customField - value to be set

setOldTypeId

void setOldTypeId(String oldTypeId)

id of the previous Custom Type. Absent if there was no previous Custom Type present.

Parameters:

oldTypeId - value to be set

of

static ProductPriceCustomFieldsSetMessagePayload of()

factory method

Returns:

instance of ProductPriceCustomFieldsSetMessagePayload

of

static ProductPriceCustomFieldsSetMessagePayload of(ProductPriceCustomFieldsSetMessagePayload template)

factory method to create a shallow copy ProductPriceCustomFieldsSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPriceCustomFieldsSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductPriceCustomFieldsSetMessagePayload deepCopy(@Nullable
 ProductPriceCustomFieldsSetMessagePayload template)

factory method to create a deep copy of ProductPriceCustomFieldsSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceCustomFieldsSetMessagePayloadBuilder builder()

builder factory method for ProductPriceCustomFieldsSetMessagePayload

Returns:

builder

builder

static ProductPriceCustomFieldsSetMessagePayloadBuilder builder(ProductPriceCustomFieldsSetMessagePayload template)

create builder for ProductPriceCustomFieldsSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceCustomFieldsSetMessagePayload

default <T> T withProductPriceCustomFieldsSetMessagePayload(Function<ProductPriceCustomFieldsSetMessagePayload,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<ProductPriceCustomFieldsSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference