Package com.commercetools.api.models.message

Class ProductStateTransitionMessageBuilder

java.lang.Object

com.commercetools.api.models.message.ProductStateTransitionMessageBuilder

All Implemented Interfaces:

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

public class ProductStateTransitionMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<ProductStateTransitionMessage>

ProductStateTransitionMessageBuilder Example to create an instance using the builder pattern

     ProductStateTransitionMessage productStateTransitionMessage = ProductStateTransitionMessage.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)
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductStateTransitionMessageBuilder()

Method Summary

Modifier and Type	Method	Description
ProductStateTransitionMessage	build()	builds ProductStateTransitionMessage with checking for non-null required values
ProductStateTransitionMessage	buildUnchecked()	builds ProductStateTransitionMessage without checking for non-null required values
ProductStateTransitionMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
ProductStateTransitionMessageBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
ProductStateTransitionMessageBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
ProductStateTransitionMessageBuilder	force(Boolean force)	Whether State transition validations were turned off during the Transition State update action.
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.
Boolean	getForce()	Whether State transition validations were turned off during the Transition State update action.
String	getId()	Unique identifier of the Message.
ZonedDateTime	getLastModifiedAt()	Value of createdAt.
LastModifiedBy	getLastModifiedBy()	Value of createdBy.
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.
Long	getSequenceNumber()	Message number in relation to other Messages for a given resource.
StateReference	getState()	Product State after the Transition State update action.
Long	getVersion()	Version of a resource.
ProductStateTransitionMessageBuilder	id(String id)	Unique identifier of the Message.
ProductStateTransitionMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
ProductStateTransitionMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Value of createdBy.
ProductStateTransitionMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Value of createdBy.
static ProductStateTransitionMessageBuilder	of()	factory method for an instance of ProductStateTransitionMessageBuilder
static ProductStateTransitionMessageBuilder	of(ProductStateTransitionMessage template)	create builder for ProductStateTransitionMessage instance
ProductStateTransitionMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
ProductStateTransitionMessageBuilder	resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
ProductStateTransitionMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
ProductStateTransitionMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
ProductStateTransitionMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
ProductStateTransitionMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
ProductStateTransitionMessageBuilder	state(StateReference state)	Product State after the Transition State update action.
ProductStateTransitionMessageBuilder	state(Function<StateReferenceBuilder,StateReferenceBuilder> builder)	Product State after the Transition State update action.
ProductStateTransitionMessageBuilder	version(Long version)	Version of a resource.
ProductStateTransitionMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
ProductStateTransitionMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Value of createdBy.
ProductStateTransitionMessageBuilder	withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)	User-provided identifiers of the resource, such as key or externalId.
ProductStateTransitionMessageBuilder	withState(Function<StateReferenceBuilder,StateReference> builder)	Product State after the Transition State update action.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductStateTransitionMessageBuilder

public ProductStateTransitionMessageBuilder()

Method Details

id

public ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder createdAt(ZonedDateTime createdAt)

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public ProductStateTransitionMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public ProductStateTransitionMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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 ProductStateTransitionMessageBuilder 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

state

public ProductStateTransitionMessageBuilder state(Function<StateReferenceBuilder,StateReferenceBuilder> builder)

Product State after the Transition State update action.

Parameters:

builder - function to build the state value

Returns:

Builder

withState

public ProductStateTransitionMessageBuilder withState(Function<StateReferenceBuilder,StateReference> builder)

Product State after the Transition State update action.

Parameters:

builder - function to build the state value

Returns:

Builder

state

public ProductStateTransitionMessageBuilder state(StateReference state)

Product State after the Transition State update action.

Parameters:

state - value to be set

Returns:

Builder

force

public ProductStateTransitionMessageBuilder force(Boolean force)

Whether State transition validations were turned off during the Transition State update action.

Parameters:

force - 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

getState

public StateReference getState()

Product State after the Transition State update action.

Returns:

state

getForce

public Boolean getForce()

Whether State transition validations were turned off during the Transition State update action.

Returns:

force

build

public ProductStateTransitionMessage build()

builds ProductStateTransitionMessage with checking for non-null required values

Specified by:

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

Returns:

ProductStateTransitionMessage

buildUnchecked

public ProductStateTransitionMessage buildUnchecked()

builds ProductStateTransitionMessage without checking for non-null required values

Returns:

ProductStateTransitionMessage

of

public static ProductStateTransitionMessageBuilder of()

factory method for an instance of ProductStateTransitionMessageBuilder

Returns:

builder

of

public static ProductStateTransitionMessageBuilder of(ProductStateTransitionMessage template)

create builder for ProductStateTransitionMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder