Package com.commercetools.api.models.message

Interface ProductVariantAddedMessage

All Superinterfaces:

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

public interface ProductVariantAddedMessage
extends Message

Generated after a successful Add ProductVariant update action.

Example to create an instance using the builder pattern

     ProductVariantAddedMessage productVariantAddedMessage = ProductVariantAddedMessage.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)
             .variant(variantBuilder -> variantBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_VARIANT_ADDED	discriminator value for ProductVariantAddedMessage

Method Summary

Modifier and Type	Method	Description
static ProductVariantAddedMessageBuilder	builder()	builder factory method for ProductVariantAddedMessage
static ProductVariantAddedMessageBuilder	builder(ProductVariantAddedMessage template)	create builder for ProductVariantAddedMessage instance
ProductVariantAddedMessage	copyDeep()
static ProductVariantAddedMessage	deepCopy(ProductVariantAddedMessage template)	factory method to create a deep copy of ProductVariantAddedMessage
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Product Projection.
@NotNull @Valid ProductVariant	getVariant()	Unique identifier of the Product Variant that was added.
static ProductVariantAddedMessage	of()	factory method
static ProductVariantAddedMessage	of(ProductVariantAddedMessage template)	factory method to create a shallow copy ProductVariantAddedMessage
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Product Projection.
void	setVariant(ProductVariant variant)	Unique identifier of the Product Variant that was added.
static com.fasterxml.jackson.core.type.TypeReference<ProductVariantAddedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductVariantAddedMessage(Function<ProductVariantAddedMessage,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_VARIANT_ADDED

static final String PRODUCT_VARIANT_ADDED

discriminator value for ProductVariantAddedMessage

See Also:

• Constant Field Values

Method Details

getVariant

@NotNull
@Valid
@NotNull @Valid ProductVariant getVariant()

Unique identifier of the Product Variant that was added.

Returns:

variant

getStaged

@NotNull
@NotNull Boolean getStaged()

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

Returns:

staged

setVariant

void setVariant(ProductVariant variant)

Unique identifier of the Product Variant that was added.

Parameters:

variant - 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 ProductVariantAddedMessage of()

factory method

Returns:

instance of ProductVariantAddedMessage

of

static ProductVariantAddedMessage of(ProductVariantAddedMessage template)

factory method to create a shallow copy ProductVariantAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductVariantAddedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static ProductVariantAddedMessage deepCopy(@Nullable
 ProductVariantAddedMessage template)

factory method to create a deep copy of ProductVariantAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductVariantAddedMessageBuilder builder()

builder factory method for ProductVariantAddedMessage

Returns:

builder

builder

static ProductVariantAddedMessageBuilder builder(ProductVariantAddedMessage template)

create builder for ProductVariantAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductVariantAddedMessage

default <T> T withProductVariantAddedMessage(Function<ProductVariantAddedMessage,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<ProductVariantAddedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference