Package com.commercetools.api.models.message

Interface ProductPriceCustomFieldRemovedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductPriceCustomFieldRemovedMessagePayload
extends MessagePayload

Generated after removing a Custom Field from a Price using the Set Price CustomField update action.

Example to create an instance using the builder pattern

     ProductPriceCustomFieldRemovedMessagePayload productPriceCustomFieldRemovedMessagePayload = ProductPriceCustomFieldRemovedMessagePayload.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_REMOVED	discriminator value for ProductPriceCustomFieldRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductPriceCustomFieldRemovedMessagePayloadBuilder	builder()	builder factory method for ProductPriceCustomFieldRemovedMessagePayload
static ProductPriceCustomFieldRemovedMessagePayloadBuilder	builder(ProductPriceCustomFieldRemovedMessagePayload template)	create builder for ProductPriceCustomFieldRemovedMessagePayload instance
ProductPriceCustomFieldRemovedMessagePayload	copyDeep()
static ProductPriceCustomFieldRemovedMessagePayload	deepCopy(ProductPriceCustomFieldRemovedMessagePayload template)	factory method to create a deep copy of ProductPriceCustomFieldRemovedMessagePayload
@NotNull String	getName()	Name of the Custom Field that was removed.
@NotNull String	getPriceId()	Unique identifier of the Price from which the Custom Field was removed.
@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 ProductPriceCustomFieldRemovedMessagePayload	of()	factory method
static ProductPriceCustomFieldRemovedMessagePayload	of(ProductPriceCustomFieldRemovedMessagePayload template)	factory method to create a shallow copy ProductPriceCustomFieldRemovedMessagePayload
void	setName(String name)	Name of the Custom Field that was removed.
void	setPriceId(String priceId)	Unique identifier of the Price from which the Custom Field was removed.
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<ProductPriceCustomFieldRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPriceCustomFieldRemovedMessagePayload(Function<ProductPriceCustomFieldRemovedMessagePayload,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_REMOVED

static final String PRODUCT_PRICE_CUSTOM_FIELD_REMOVED

discriminator value for ProductPriceCustomFieldRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getPriceId

@NotNull
@NotNull String getPriceId()

Unique identifier of the Price from which the Custom Field was removed.

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

Returns:

name

setPriceId

void setPriceId(String priceId)

Unique identifier of the Price from which the Custom Field was removed.

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

Parameters:

name - value to be set

of

static ProductPriceCustomFieldRemovedMessagePayload of()

factory method

Returns:

instance of ProductPriceCustomFieldRemovedMessagePayload

of

static ProductPriceCustomFieldRemovedMessagePayload of(ProductPriceCustomFieldRemovedMessagePayload template)

factory method to create a shallow copy ProductPriceCustomFieldRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPriceCustomFieldRemovedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductPriceCustomFieldRemovedMessagePayload deepCopy(@Nullable
 ProductPriceCustomFieldRemovedMessagePayload template)

factory method to create a deep copy of ProductPriceCustomFieldRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceCustomFieldRemovedMessagePayloadBuilder builder()

builder factory method for ProductPriceCustomFieldRemovedMessagePayload

Returns:

builder

builder

static ProductPriceCustomFieldRemovedMessagePayloadBuilder builder(ProductPriceCustomFieldRemovedMessagePayload template)

create builder for ProductPriceCustomFieldRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceCustomFieldRemovedMessagePayload

default <T> T withProductPriceCustomFieldRemovedMessagePayload(Function<ProductPriceCustomFieldRemovedMessagePayload,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<ProductPriceCustomFieldRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference