Package com.commercetools.api.models.message

Class OrderStateTransitionMessageBuilder

java.lang.Object

com.commercetools.api.models.message.OrderStateTransitionMessageBuilder

All Implemented Interfaces:

Builder<OrderStateTransitionMessage>

public class OrderStateTransitionMessageBuilder
extends Object
implements Builder<OrderStateTransitionMessage>

OrderStateTransitionMessageBuilder Example to create an instance using the builder pattern

     OrderStateTransitionMessage orderStateTransitionMessage = OrderStateTransitionMessage.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
OrderStateTransitionMessageBuilder()

Method Summary

Modifier and Type	Method	Description
OrderStateTransitionMessage	build()	builds OrderStateTransitionMessage with checking for non-null required values
OrderStateTransitionMessage	buildUnchecked()	builds OrderStateTransitionMessage without checking for non-null required values
OrderStateTransitionMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
OrderStateTransitionMessageBuilder	createdBy(CreatedBy createdBy)	IDs and references that created the Message.
OrderStateTransitionMessageBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	IDs and references that created the Message.
OrderStateTransitionMessageBuilder	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()	IDs and references that created the Message.
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()	IDs and references that last modified the Message.
StateReference	getOldState()	OrderState before the Transition State 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.
Long	getSequenceNumber()	Message number in relation to other Messages for a given resource.
StateReference	getState()	OrderState after the Transition State update action.
Long	getVersion()	Version of a resource.
OrderStateTransitionMessageBuilder	id(String id)	Unique identifier of the Message.
OrderStateTransitionMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
OrderStateTransitionMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	IDs and references that last modified the Message.
OrderStateTransitionMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	IDs and references that last modified the Message.
static OrderStateTransitionMessageBuilder	of()	factory method for an instance of OrderStateTransitionMessageBuilder
static OrderStateTransitionMessageBuilder	of(OrderStateTransitionMessage template)	create builder for OrderStateTransitionMessage instance
OrderStateTransitionMessageBuilder	oldState(StateReference oldState)	OrderState before the Transition State update action.
OrderStateTransitionMessageBuilder	oldState(Function<StateReferenceBuilder,StateReferenceBuilder> builder)	OrderState before the Transition State update action.
OrderStateTransitionMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
OrderStateTransitionMessageBuilder	resource(Function<ReferenceBuilder,Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
OrderStateTransitionMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
OrderStateTransitionMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
OrderStateTransitionMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
OrderStateTransitionMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
OrderStateTransitionMessageBuilder	state(StateReference state)	OrderState after the Transition State update action.
OrderStateTransitionMessageBuilder	state(Function<StateReferenceBuilder,StateReferenceBuilder> builder)	OrderState after the Transition State update action.
OrderStateTransitionMessageBuilder	version(Long version)	Version of a resource.
OrderStateTransitionMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	IDs and references that created the Message.
OrderStateTransitionMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	IDs and references that last modified the Message.
OrderStateTransitionMessageBuilder	withOldState(Function<StateReferenceBuilder,StateReference> builder)	OrderState before the Transition State update action.
OrderStateTransitionMessageBuilder	withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)	User-provided identifiers of the resource, such as key or externalId.
OrderStateTransitionMessageBuilder	withState(Function<StateReferenceBuilder,StateReference> builder)	OrderState after the Transition State update action.

Methods inherited from class java.lang.Object

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

Constructor Details

OrderStateTransitionMessageBuilder

public OrderStateTransitionMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public OrderStateTransitionMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

IDs and references that last modified the Message.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

IDs and references that last modified the Message.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public OrderStateTransitionMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

IDs and references that last modified the Message.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public OrderStateTransitionMessageBuilder createdBy(@Nullable
 CreatedBy createdBy)

IDs and references that created the Message.

Parameters:

createdBy - value to be set

Returns:

Builder

sequenceNumber

public OrderStateTransitionMessageBuilder 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 OrderStateTransitionMessageBuilder 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 OrderStateTransitionMessageBuilder resource(Function<ReferenceBuilder,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 OrderStateTransitionMessageBuilder 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 OrderStateTransitionMessageBuilder 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 OrderStateTransitionMessageBuilder 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 OrderStateTransitionMessageBuilder 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 OrderStateTransitionMessageBuilder state(Function<StateReferenceBuilder,StateReferenceBuilder> builder)

OrderState after the Transition State update action.

Parameters:

builder - function to build the state value

Returns:

Builder

withState

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

OrderState after the Transition State update action.

Parameters:

builder - function to build the state value

Returns:

Builder

state

public OrderStateTransitionMessageBuilder state(StateReference state)

OrderState after the Transition State update action.

Parameters:

state - value to be set

Returns:

Builder

oldState

public OrderStateTransitionMessageBuilder oldState(Function<StateReferenceBuilder,StateReferenceBuilder> builder)

OrderState before the Transition State update action.

Parameters:

builder - function to build the oldState value

Returns:

Builder

withOldState

public OrderStateTransitionMessageBuilder withOldState(Function<StateReferenceBuilder,StateReference> builder)

OrderState before the Transition State update action.

Parameters:

builder - function to build the oldState value

Returns:

Builder

oldState

public OrderStateTransitionMessageBuilder oldState(@Nullable
 StateReference oldState)

OrderState before the Transition State update action.

Parameters:

oldState - value to be set

Returns:

Builder

force

public OrderStateTransitionMessageBuilder 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()

IDs and references that last modified the Message.

Returns:

lastModifiedBy

getCreatedBy

@Nullable
public CreatedBy getCreatedBy()

IDs and references that created the Message.

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

OrderState after the Transition State update action.

Returns:

state

getOldState

@Nullable
public StateReference getOldState()

OrderState before the Transition State update action.

Returns:

oldState

getForce

public Boolean getForce()

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

Returns:

force

build

public OrderStateTransitionMessage build()

builds OrderStateTransitionMessage with checking for non-null required values

Specified by:

build in interface Builder<OrderStateTransitionMessage>

Returns:

OrderStateTransitionMessage

buildUnchecked

public OrderStateTransitionMessage buildUnchecked()

builds OrderStateTransitionMessage without checking for non-null required values

Returns:

OrderStateTransitionMessage

of

public static OrderStateTransitionMessageBuilder of()

factory method for an instance of OrderStateTransitionMessageBuilder

Returns:

builder

of

public static OrderStateTransitionMessageBuilder of(OrderStateTransitionMessage template)

create builder for OrderStateTransitionMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder