Package com.commercetools.api.models.message

Class ProductPublishedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.ProductPublishedMessageBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<ProductPublishedMessage>

public class ProductPublishedMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<ProductPublishedMessage>

ProductPublishedMessageBuilder 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()
 

Constructor Summary

Constructors

Constructor	Description
ProductPublishedMessageBuilder()

Method Summary

Modifier and Type	Method	Description
ProductPublishedMessage	build()	builds ProductPublishedMessage with checking for non-null required values
ProductPublishedMessage	buildUnchecked()	builds ProductPublishedMessage without checking for non-null required values
ProductPublishedMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
ProductPublishedMessageBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
ProductPublishedMessageBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Message was generated.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
String	getId()	Unique identifier of the Message.
ZonedDateTime	getLastModifiedAt()	Value of createdAt.
LastModifiedBy	getLastModifiedBy()	Value of createdBy.
ProductProjection	getProductProjection()	Current Product Projection of the Product at the time of creation.
List<String>	getRemovedImageUrls()	List of image URLs which were removed during the Publish update action.
Reference	getResource()	Reference to the resource on which the change or action was performed.
UserProvidedIdentifiers	getResourceUserProvidedIdentifiers()	User-provided identifiers of the resource, such as key or externalId.
Long	getResourceVersion()	Version of the resource on which the change or action was performed.
ProductPublishScope	getScope()	Publishing Scope that was used during the Publish update action.
Long	getSequenceNumber()	Message number in relation to other Messages for a given resource.
Long	getVersion()	Version of a resource.
ProductPublishedMessageBuilder	id(String id)	Unique identifier of the Message.
ProductPublishedMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
ProductPublishedMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Value of createdBy.
ProductPublishedMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Value of createdBy.
static ProductPublishedMessageBuilder	of()	factory method for an instance of ProductPublishedMessageBuilder
static ProductPublishedMessageBuilder	of(ProductPublishedMessage template)	create builder for ProductPublishedMessage instance
ProductPublishedMessageBuilder	plusRemovedImageUrls(String... removedImageUrls)	List of image URLs which were removed during the Publish update action.
ProductPublishedMessageBuilder	productProjection(ProductProjection productProjection)	Current Product Projection of the Product at the time of creation.
ProductPublishedMessageBuilder	productProjection(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)	Current Product Projection of the Product at the time of creation.
ProductPublishedMessageBuilder	removedImageUrls(String... removedImageUrls)	List of image URLs which were removed during the Publish update action.
ProductPublishedMessageBuilder	removedImageUrls(List<String> removedImageUrls)	List of image URLs which were removed during the Publish update action.
ProductPublishedMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
ProductPublishedMessageBuilder	resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
ProductPublishedMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
ProductPublishedMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
ProductPublishedMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
ProductPublishedMessageBuilder	scope(ProductPublishScope scope)	Publishing Scope that was used during the Publish update action.
ProductPublishedMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
ProductPublishedMessageBuilder	version(Long version)	Version of a resource.
ProductPublishedMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
ProductPublishedMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Value of createdBy.
ProductPublishedMessageBuilder	withProductProjection(Function<ProductProjectionBuilder,ProductProjection> builder)	Current Product Projection of the Product at the time of creation.
ProductPublishedMessageBuilder	withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)	User-provided identifiers of the resource, such as key or externalId.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProductPublishedMessageBuilder

public ProductPublishedMessageBuilder()

Method Details

id

public ProductPublishedMessageBuilder id(String id)

Unique identifier of the Message. Can be used to track which Messages have been processed.

Parameters:

id - value to be set

Returns:

Builder

version

public ProductPublishedMessageBuilder version(Long version)

Version of a resource. In case of Messages, this is always 1.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public ProductPublishedMessageBuilder createdAt(ZonedDateTime createdAt)

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public ProductPublishedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public ProductPublishedMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

public ProductPublishedMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public ProductPublishedMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public ProductPublishedMessageBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

public ProductPublishedMessageBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public ProductPublishedMessageBuilder createdBy(@Nullable
 CreatedBy createdBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

createdBy - value to be set

Returns:

Builder

sequenceNumber

public ProductPublishedMessageBuilder sequenceNumber(Long sequenceNumber)

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

Parameters:

sequenceNumber - value to be set

Returns:

Builder

resource

public ProductPublishedMessageBuilder resource(Reference resource)

Reference to the resource on which the change or action was performed.

Parameters:

resource - value to be set

Returns:

Builder

resource

public ProductPublishedMessageBuilder resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)

Reference to the resource on which the change or action was performed.

Parameters:

builder - function to build the resource value

Returns:

Builder

resourceVersion

public ProductPublishedMessageBuilder resourceVersion(Long resourceVersion)

Version of the resource on which the change or action was performed.

Parameters:

resourceVersion - value to be set

Returns:

Builder

resourceUserProvidedIdentifiers

public ProductPublishedMessageBuilder resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Parameters:

builder - function to build the resourceUserProvidedIdentifiers value

Returns:

Builder

withResourceUserProvidedIdentifiers

public ProductPublishedMessageBuilder withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Parameters:

builder - function to build the resourceUserProvidedIdentifiers value

Returns:

Builder

resourceUserProvidedIdentifiers

public ProductPublishedMessageBuilder resourceUserProvidedIdentifiers(@Nullable
 UserProvidedIdentifiers resourceUserProvidedIdentifiers)

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Parameters:

resourceUserProvidedIdentifiers - value to be set

Returns:

Builder

removedImageUrls

public ProductPublishedMessageBuilder removedImageUrls(String... removedImageUrls)

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

Parameters:

removedImageUrls - value to be set

Returns:

Builder

removedImageUrls

public ProductPublishedMessageBuilder removedImageUrls(List<String> removedImageUrls)

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

Parameters:

removedImageUrls - value to be set

Returns:

Builder

plusRemovedImageUrls

public ProductPublishedMessageBuilder plusRemovedImageUrls(String... removedImageUrls)

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

Parameters:

removedImageUrls - value to be set

Returns:

Builder

productProjection

public ProductPublishedMessageBuilder productProjection(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)

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

Parameters:

builder - function to build the productProjection value

Returns:

Builder

withProductProjection

public ProductPublishedMessageBuilder withProductProjection(Function<ProductProjectionBuilder,ProductProjection> builder)

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

Parameters:

builder - function to build the productProjection value

Returns:

Builder

productProjection

public ProductPublishedMessageBuilder productProjection(ProductProjection productProjection)

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

Parameters:

productProjection - value to be set

Returns:

Builder

scope

public ProductPublishedMessageBuilder scope(ProductPublishScope scope)

Publishing Scope that was used during the Publish update action.

Parameters:

scope - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the Message. Can be used to track which Messages have been processed.

Returns:

id

getVersion

public Long getVersion()

Version of a resource. In case of Messages, this is always 1.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the Message was generated.

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Value of createdAt.

Returns:

lastModifiedAt

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

Value of createdBy.

Returns:

lastModifiedBy

getCreatedBy

@Nullable
public CreatedBy getCreatedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

createdBy

getSequenceNumber

public Long getSequenceNumber()

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

Returns:

sequenceNumber

getResource

public Reference getResource()

Reference to the resource on which the change or action was performed.

Returns:

resource

getResourceVersion

public Long getResourceVersion()

Version of the resource on which the change or action was performed.

Returns:

resourceVersion

getResourceUserProvidedIdentifiers

@Nullable
public UserProvidedIdentifiers getResourceUserProvidedIdentifiers()

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Returns:

resourceUserProvidedIdentifiers

getRemovedImageUrls

public List<String> getRemovedImageUrls()

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

Returns:

removedImageUrls

getProductProjection

public ProductProjection getProductProjection()

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

Returns:

productProjection

getScope

public ProductPublishScope getScope()

Publishing Scope that was used during the Publish update action.

Returns:

scope

build

public ProductPublishedMessage build()

builds ProductPublishedMessage with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<ProductPublishedMessage>

Returns:

ProductPublishedMessage

buildUnchecked

public ProductPublishedMessage buildUnchecked()

builds ProductPublishedMessage without checking for non-null required values

Returns:

ProductPublishedMessage

of

public static ProductPublishedMessageBuilder of()

factory method for an instance of ProductPublishedMessageBuilder

Returns:

builder

of

public static ProductPublishedMessageBuilder of(ProductPublishedMessage template)

create builder for ProductPublishedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder