Package com.commercetools.api.models.message

Interface ProductVariantAddedMessagePayload

All Superinterfaces:

MessagePayload

All Known Implementing Classes:

ProductVariantAddedMessagePayloadImpl

public interface ProductVariantAddedMessagePayload
extends MessagePayload

Generated after a successful Add Product Variant update action.

Example to create an instance using the builder pattern

     ProductVariantAddedMessagePayload productVariantAddedMessagePayload = ProductVariantAddedMessagePayload.builder()
             .variant(variantBuilder -> variantBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

getType, withMessagePayload

Field Details

PRODUCT_VARIANT_ADDED

static final String PRODUCT_VARIANT_ADDED

discriminator value for ProductVariantAddedMessagePayload

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

factory method

Returns:

instance of ProductVariantAddedMessagePayload

of

static ProductVariantAddedMessagePayload of(ProductVariantAddedMessagePayload template)

factory method to create a shallow copy ProductVariantAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductVariantAddedMessagePayload deepCopy(@Nullable
 ProductVariantAddedMessagePayload template)

factory method to create a deep copy of ProductVariantAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductVariantAddedMessagePayloadBuilder builder()

builder factory method for ProductVariantAddedMessagePayload

Returns:

builder

builder

static ProductVariantAddedMessagePayloadBuilder builder(ProductVariantAddedMessagePayload template)

create builder for ProductVariantAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductVariantAddedMessagePayload

default <T> T withProductVariantAddedMessagePayload(Function<ProductVariantAddedMessagePayload,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<ProductVariantAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference