Package com.commercetools.api.models.message

Interface ProductPublishedMessage

All Superinterfaces:

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

All Known Implementing Classes:

ProductPublishedMessageImpl

public interface ProductPublishedMessage
extends Message

Generated after a successful Publish update action.

Example to create an instance using the builder pattern

     ProductPublishedMessage productPublishedMessage = ProductPublishedMessage.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)
             .plusRemovedImageUrls(removedImageUrlsBuilder -> removedImageUrlsBuilder)
             .productProjection(productProjectionBuilder -> productProjectionBuilder)
             .scope(ProductPublishScope.ALL)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_PUBLISHED	discriminator value for ProductPublishedMessage

Method Summary

Modifier and Type	Method	Description
static ProductPublishedMessageBuilder	builder()	builder factory method for ProductPublishedMessage
static ProductPublishedMessageBuilder	builder(ProductPublishedMessage template)	create builder for ProductPublishedMessage instance
static ProductPublishedMessage	deepCopy(ProductPublishedMessage template)	factory method to create a deep copy of ProductPublishedMessage
@NotNull @Valid ProductProjection	getProductProjection()	Current Product Projection of the Product at the time of creation.
@NotNull List<String>	getRemovedImageUrls()	List of image URLs which were removed during the Publish update action.
@NotNull ProductPublishScope	getScope()	Publishing Scope that was used during the Publish update action.
static ProductPublishedMessage	of()	factory method
static ProductPublishedMessage	of(ProductPublishedMessage template)	factory method to create a shallow copy ProductPublishedMessage
void	setProductProjection(ProductProjection productProjection)	Current Product Projection of the Product at the time of creation.
void	setRemovedImageUrls(String... removedImageUrls)	List of image URLs which were removed during the Publish update action.
void	setRemovedImageUrls(List<String> removedImageUrls)	List of image URLs which were removed during the Publish update action.
void	setScope(ProductPublishScope scope)	Publishing Scope that was used during the Publish update action.
static com.fasterxml.jackson.core.type.TypeReference<ProductPublishedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductPublishedMessage(Function<ProductPublishedMessage,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_PUBLISHED

static final String PRODUCT_PUBLISHED

discriminator value for ProductPublishedMessage

See Also:

• Constant Field Values

Method Details

getRemovedImageUrls

@NotNull
@NotNull List<String> getRemovedImageUrls()

List of image URLs which were removed during the Publish update action.

Returns:

removedImageUrls

getProductProjection

@NotNull
@Valid
@NotNull @Valid ProductProjection getProductProjection()

Current Product Projection of the Product at the time of creation.

Returns:

productProjection

getScope

@NotNull
@NotNull ProductPublishScope getScope()

Publishing Scope that was used during the Publish update action.

Returns:

scope

setRemovedImageUrls

void setRemovedImageUrls(String... removedImageUrls)

List of image URLs which were removed during the Publish update action.

Parameters:

removedImageUrls - values to be set

setRemovedImageUrls

void setRemovedImageUrls(List<String> removedImageUrls)

List of image URLs which were removed during the Publish update action.

Parameters:

removedImageUrls - values to be set

setProductProjection

void setProductProjection(ProductProjection productProjection)

Current Product Projection of the Product at the time of creation.

Parameters:

productProjection - value to be set

setScope

void setScope(ProductPublishScope scope)

Publishing Scope that was used during the Publish update action.

Parameters:

scope - value to be set

of

static ProductPublishedMessage of()

factory method

Returns:

instance of ProductPublishedMessage

of

static ProductPublishedMessage of(ProductPublishedMessage template)

factory method to create a shallow copy ProductPublishedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductPublishedMessage deepCopy(@Nullable
 ProductPublishedMessage template)

factory method to create a deep copy of ProductPublishedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductPublishedMessageBuilder builder()

builder factory method for ProductPublishedMessage

Returns:

builder

builder

static ProductPublishedMessageBuilder builder(ProductPublishedMessage template)

create builder for ProductPublishedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductPublishedMessage

default <T> T withProductPublishedMessage(Function<ProductPublishedMessage,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<ProductPublishedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference