Package com.commercetools.api.models.message

Interface VariantImagesSetMessage

All Superinterfaces:

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

public interface VariantImagesSetMessage
extends Message

Generated after a successful Set Images update action.

Example to create an instance using the builder pattern

     VariantImagesSetMessage variantImagesSetMessage = VariantImagesSetMessage.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)
             .plusImages(imagesBuilder -> imagesBuilder)
             .plusOldImages(oldImagesBuilder -> oldImagesBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VARIANT_IMAGES_SET	discriminator value for VariantImagesSetMessage

Method Summary

Modifier and Type	Method	Description
static VariantImagesSetMessageBuilder	builder()	builder factory method for VariantImagesSetMessage
static VariantImagesSetMessageBuilder	builder(VariantImagesSetMessage template)	create builder for VariantImagesSetMessage instance
VariantImagesSetMessage	copyDeep()
static VariantImagesSetMessage	deepCopy(VariantImagesSetMessage template)	factory method to create a deep copy of VariantImagesSetMessage
@NotNull @Valid List<Image>	getImages()	The images that were set on the Variant.
@NotNull @Valid List<Image>	getOldImages()	The previous images of the Variant.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Variant.
static VariantImagesSetMessage	of()	factory method
static VariantImagesSetMessage	of(VariantImagesSetMessage template)	factory method to create a shallow copy VariantImagesSetMessage
void	setImages(Image... images)	The images that were set on the Variant.
void	setImages(List<Image> images)	The images that were set on the Variant.
void	setOldImages(Image... oldImages)	The previous images of the Variant.
void	setOldImages(List<Image> oldImages)	The previous images of the Variant.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Variant.
static tools.jackson.core.type.TypeReference<VariantImagesSetMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withVariantImagesSetMessage(Function<VariantImagesSetMessage,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

VARIANT_IMAGES_SET

static final String VARIANT_IMAGES_SET

discriminator value for VariantImagesSetMessage

See Also:

• Constant Field Values

Method Details

getImages

@NotNull
@Valid
@NotNull @Valid List<Image> getImages()

The images that were set on the Variant.

Returns:

images

getOldImages

@NotNull
@Valid
@NotNull @Valid List<Image> getOldImages()

The previous images of the Variant.

Returns:

oldImages

getStaged

@NotNull
@NotNull Boolean getStaged()

Whether the update was only applied to the staged Variant.

Returns:

staged

setImages

void setImages(Image... images)

The images that were set on the Variant.

Parameters:

images - values to be set

setImages

void setImages(List<Image> images)

The images that were set on the Variant.

Parameters:

images - values to be set

setOldImages

void setOldImages(Image... oldImages)

The previous images of the Variant.

Parameters:

oldImages - values to be set

setOldImages

void setOldImages(List<Image> oldImages)

The previous images of the Variant.

Parameters:

oldImages - values 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 VariantImagesSetMessage of()

factory method

Returns:

instance of VariantImagesSetMessage

of

static VariantImagesSetMessage of(VariantImagesSetMessage template)

factory method to create a shallow copy VariantImagesSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

VariantImagesSetMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static VariantImagesSetMessage deepCopy(@Nullable
 VariantImagesSetMessage template)

factory method to create a deep copy of VariantImagesSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static VariantImagesSetMessageBuilder builder()

builder factory method for VariantImagesSetMessage

Returns:

builder

builder

static VariantImagesSetMessageBuilder builder(VariantImagesSetMessage template)

create builder for VariantImagesSetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withVariantImagesSetMessage

default <T> T withVariantImagesSetMessage(Function<VariantImagesSetMessage,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<VariantImagesSetMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference