Package com.commercetools.api.models.message

Interface ProductPriceKeySetMessage

All Superinterfaces:

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

public interface ProductPriceKeySetMessage
extends Message

Generated after a successful Set Price Key update action.

Example to create an instance using the builder pattern

     ProductPriceKeySetMessage productPriceKeySetMessage = ProductPriceKeySetMessage.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)
             .variantId(0.3)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_PRICE_KEY_SET	discriminator value for ProductPriceKeySetMessage

Method Summary

Modifier and Type	Method	Description
static ProductPriceKeySetMessageBuilder	builder()	builder factory method for ProductPriceKeySetMessage
static ProductPriceKeySetMessageBuilder	builder(ProductPriceKeySetMessage template)	create builder for ProductPriceKeySetMessage instance
ProductPriceKeySetMessage	copyDeep()
static ProductPriceKeySetMessage	deepCopy(ProductPriceKeySetMessage template)	factory method to create a deep copy of ProductPriceKeySetMessage
String	getKey()	key value of the Price after the Set Price Key update action.
String	getOldKey()	key value of the Price before the Set Price Key update action.
String	getPriceId()	Unique identifier of the Price.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Product Projection.
@NotNull Long	getVariantId()
static ProductPriceKeySetMessage	of()	factory method
static ProductPriceKeySetMessage	of(ProductPriceKeySetMessage template)	factory method to create a shallow copy ProductPriceKeySetMessage
void	setKey(String key)	key value of the Price after the Set Price Key update action.
void	setOldKey(String oldKey)	key value of the Price before the Set Price Key update action.
void	setPriceId(String priceId)	Unique identifier of the Price.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Product Projection.
void	setVariantId(Long variantId)	set variantId
static com.fasterxml.jackson.core.type.TypeReference<ProductPriceKeySetMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPriceKeySetMessage(Function<ProductPriceKeySetMessage,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_KEY_SET

static final String PRODUCT_PRICE_KEY_SET

discriminator value for ProductPriceKeySetMessage

See Also:

• Constant Field Values

Method Details

getVariantId

@NotNull
@NotNull Long getVariantId()

Returns:

variantId

getPriceId

String getPriceId()

Unique identifier of the Price.

Returns:

priceId

getOldKey

String getOldKey()

key value of the Price before the Set Price Key update action.

Returns:

oldKey

getKey

String getKey()

key value of the Price after the Set Price Key update action.

Returns:

key

getStaged

@NotNull
@NotNull Boolean getStaged()

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

Returns:

staged

setVariantId

void setVariantId(Long variantId)

set variantId

Parameters:

variantId - value to be set

setPriceId

void setPriceId(String priceId)

Unique identifier of the Price.

Parameters:

priceId - value to be set

setOldKey

void setOldKey(String oldKey)

key value of the Price before the Set Price Key update action.

Parameters:

oldKey - value to be set

setKey

void setKey(String key)

key value of the Price after the Set Price Key update action.

Parameters:

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

of

static ProductPriceKeySetMessage of()

factory method

Returns:

instance of ProductPriceKeySetMessage

of

static ProductPriceKeySetMessage of(ProductPriceKeySetMessage template)

factory method to create a shallow copy ProductPriceKeySetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductPriceKeySetMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static ProductPriceKeySetMessage deepCopy(@Nullable
 ProductPriceKeySetMessage template)

factory method to create a deep copy of ProductPriceKeySetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPriceKeySetMessageBuilder builder()

builder factory method for ProductPriceKeySetMessage

Returns:

builder

builder

static ProductPriceKeySetMessageBuilder builder(ProductPriceKeySetMessage template)

create builder for ProductPriceKeySetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPriceKeySetMessage

default <T> T withProductPriceKeySetMessage(Function<ProductPriceKeySetMessage,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<ProductPriceKeySetMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference