Package com.commercetools.api.models.message

Class OrderStateChangedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.OrderStateChangedMessageBuilder

All Implemented Interfaces:

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

public class OrderStateChangedMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<OrderStateChangedMessage>

OrderStateChangedMessageBuilder Example to create an instance using the builder pattern

     OrderStateChangedMessage orderStateChangedMessage = OrderStateChangedMessage.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)
             .orderState(OrderState.OPEN)
             .oldOrderState(OrderState.OPEN)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
OrderStateChangedMessageBuilder()

Method Summary

Modifier and Type	Method	Description
OrderStateChangedMessage	build()	builds OrderStateChangedMessage with checking for non-null required values
OrderStateChangedMessage	buildUnchecked()	builds OrderStateChangedMessage without checking for non-null required values
OrderStateChangedMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
OrderStateChangedMessageBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
OrderStateChangedMessageBuilder	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.
OrderState	getOldOrderState()	OrderState before the Change Order State update action.
OrderState	getOrderState()	OrderState after the Change Order 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.
Long	getVersion()	Version of a resource.
OrderStateChangedMessageBuilder	id(String id)	Unique identifier of the Message.
OrderStateChangedMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
OrderStateChangedMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Value of createdBy.
OrderStateChangedMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Value of createdBy.
static OrderStateChangedMessageBuilder	of()	factory method for an instance of OrderStateChangedMessageBuilder
static OrderStateChangedMessageBuilder	of(OrderStateChangedMessage template)	create builder for OrderStateChangedMessage instance
OrderStateChangedMessageBuilder	oldOrderState(OrderState oldOrderState)	OrderState before the Change Order State update action.
OrderStateChangedMessageBuilder	orderState(OrderState orderState)	OrderState after the Change Order State update action.
OrderStateChangedMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
OrderStateChangedMessageBuilder	resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
OrderStateChangedMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
OrderStateChangedMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
OrderStateChangedMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
OrderStateChangedMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
OrderStateChangedMessageBuilder	version(Long version)	Version of a resource.
OrderStateChangedMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
OrderStateChangedMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Value of createdBy.
OrderStateChangedMessageBuilder	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

OrderStateChangedMessageBuilder

public OrderStateChangedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public OrderStateChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public OrderStateChangedMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

orderState

public OrderStateChangedMessageBuilder orderState(OrderState orderState)

OrderState after the Change Order State update action.

Parameters:

orderState - value to be set

Returns:

Builder

oldOrderState

public OrderStateChangedMessageBuilder oldOrderState(OrderState oldOrderState)

OrderState before the Change Order State update action.

Parameters:

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

getOrderState

public OrderState getOrderState()

OrderState after the Change Order State update action.

Returns:

orderState

getOldOrderState

public OrderState getOldOrderState()

OrderState before the Change Order State update action.

Returns:

oldOrderState

build

public OrderStateChangedMessage build()

builds OrderStateChangedMessage with checking for non-null required values

Specified by:

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

Returns:

OrderStateChangedMessage

buildUnchecked

public OrderStateChangedMessage buildUnchecked()

builds OrderStateChangedMessage without checking for non-null required values

Returns:

OrderStateChangedMessage

of

public static OrderStateChangedMessageBuilder of()

factory method for an instance of OrderStateChangedMessageBuilder

Returns:

builder

of

public static OrderStateChangedMessageBuilder of(OrderStateChangedMessage template)

create builder for OrderStateChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder