Package com.commercetools.api.models.message

Interface ProductPriceCustomFieldChangedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface ProductPriceCustomFieldChangedMessage
extends Message

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

     ProductPriceCustomFieldChangedMessage productPriceCustomFieldChangedMessage = ProductPriceCustomFieldChangedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .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 ProductPriceCustomFieldChangedMessage

Method Summary

Modifier and Type	Method	Description
static ProductPriceCustomFieldChangedMessageBuilder	builder()	builder factory method for ProductPriceCustomFieldChangedMessage
static ProductPriceCustomFieldChangedMessageBuilder	builder(ProductPriceCustomFieldChangedMessage template)	create builder for ProductPriceCustomFieldChangedMessage instance
ProductPriceCustomFieldChangedMessage	copyDeep()
static ProductPriceCustomFieldChangedMessage	deepCopy(ProductPriceCustomFieldChangedMessage template)	factory method to create a deep copy of ProductPriceCustomFieldChangedMessage
@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 ProductPriceCustomFieldChangedMessage	of()	factory method
static ProductPriceCustomFieldChangedMessage	of(ProductPriceCustomFieldChangedMessage template)	factory method to create a shallow copy ProductPriceCustomFieldChangedMessage
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<ProductPriceCustomFieldChangedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPriceCustomFieldChangedMessage(Function<ProductPriceCustomFieldChangedMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

PRODUCT_PRICE_CUSTOM_FIELD_CHANGED

static final String PRODUCT_PRICE_CUSTOM_FIELD_CHANGED

discriminator value for ProductPriceCustomFieldChangedMessage

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 ProductPriceCustomFieldChangedMessage of()

factory method

Returns:

instance of ProductPriceCustomFieldChangedMessage

of

static ProductPriceCustomFieldChangedMessage of(ProductPriceCustomFieldChangedMessage template)

factory method to create a shallow copy ProductPriceCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPriceCustomFieldChangedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static ProductPriceCustomFieldChangedMessage deepCopy(@Nullable
 ProductPriceCustomFieldChangedMessage template)

factory method to create a deep copy of ProductPriceCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceCustomFieldChangedMessageBuilder builder()

builder factory method for ProductPriceCustomFieldChangedMessage

Returns:

builder

builder

static ProductPriceCustomFieldChangedMessageBuilder builder(ProductPriceCustomFieldChangedMessage template)

create builder for ProductPriceCustomFieldChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceCustomFieldChangedMessage

default <T> T withProductPriceCustomFieldChangedMessage(Function<ProductPriceCustomFieldChangedMessage,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<ProductPriceCustomFieldChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference