Package com.commercetools.api.models.message

Interface VariantImageAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface VariantImageAddedMessagePayload
extends MessagePayload

Generated after a successful Add External Image update action.

Example to create an instance using the builder pattern

     VariantImageAddedMessagePayload variantImageAddedMessagePayload = VariantImageAddedMessagePayload.builder()
             .image(imageBuilder -> imageBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VARIANT_IMAGE_ADDED	discriminator value for VariantImageAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static VariantImageAddedMessagePayloadBuilder	builder()	builder factory method for VariantImageAddedMessagePayload
static VariantImageAddedMessagePayloadBuilder	builder(VariantImageAddedMessagePayload template)	create builder for VariantImageAddedMessagePayload instance
VariantImageAddedMessagePayload	copyDeep()
static VariantImageAddedMessagePayload	deepCopy(VariantImageAddedMessagePayload template)	factory method to create a deep copy of VariantImageAddedMessagePayload
@NotNull @Valid Image	getImage()	Image that was added.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Variant.
static VariantImageAddedMessagePayload	of()	factory method
static VariantImageAddedMessagePayload	of(VariantImageAddedMessagePayload template)	factory method to create a shallow copy VariantImageAddedMessagePayload
void	setImage(Image image)	Image that was added.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Variant.
static tools.jackson.core.type.TypeReference<VariantImageAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withVariantImageAddedMessagePayload(Function<VariantImageAddedMessagePayload,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

VARIANT_IMAGE_ADDED

static final String VARIANT_IMAGE_ADDED

discriminator value for VariantImageAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getImage

@NotNull
@Valid
@NotNull @Valid Image getImage()

Image that was added.

Returns:

image

getStaged

@NotNull
@NotNull Boolean getStaged()

Whether the update was only applied to the staged Variant.

Returns:

staged

setImage

void setImage(Image image)

Image that was added.

Parameters:

image - value to be set

setStaged

void setStaged(Boolean staged)

Whether the update was only applied to the staged Variant.

Parameters:

staged - value to be set

of

static VariantImageAddedMessagePayload of()

factory method

Returns:

instance of VariantImageAddedMessagePayload

of

static VariantImageAddedMessagePayload of(VariantImageAddedMessagePayload template)

factory method to create a shallow copy VariantImageAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

VariantImageAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static VariantImageAddedMessagePayload deepCopy(@Nullable
 VariantImageAddedMessagePayload template)

factory method to create a deep copy of VariantImageAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static VariantImageAddedMessagePayloadBuilder builder()

builder factory method for VariantImageAddedMessagePayload

Returns:

builder

builder

static VariantImageAddedMessagePayloadBuilder builder(VariantImageAddedMessagePayload template)

create builder for VariantImageAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withVariantImageAddedMessagePayload

default <T> T withVariantImageAddedMessagePayload(Function<VariantImageAddedMessagePayload,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<VariantImageAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference