Package com.commercetools.api.models.message

Class OrderPaymentStateChangedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.OrderPaymentStateChangedMessageBuilder

All Implemented Interfaces:

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

public class OrderPaymentStateChangedMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<OrderPaymentStateChangedMessage>

OrderPaymentStateChangedMessageBuilder Example to create an instance using the builder pattern

     OrderPaymentStateChangedMessage orderPaymentStateChangedMessage = OrderPaymentStateChangedMessage.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)
             .paymentState(PaymentState.BALANCE_DUE)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
OrderPaymentStateChangedMessageBuilder()

Method Summary

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

OrderPaymentStateChangedMessageBuilder

public OrderPaymentStateChangedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public OrderPaymentStateChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public OrderPaymentStateChangedMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

paymentState

public OrderPaymentStateChangedMessageBuilder paymentState(PaymentState paymentState)

PaymentState after the Change Payment State update action.

Parameters:

paymentState - value to be set

Returns:

Builder

oldPaymentState

public OrderPaymentStateChangedMessageBuilder oldPaymentState(@Nullable
 PaymentState oldPaymentState)

PaymentState before the Change Payment State update action.

Parameters:

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

getPaymentState

public PaymentState getPaymentState()

PaymentState after the Change Payment State update action.

Returns:

paymentState

getOldPaymentState

@Nullable
public PaymentState getOldPaymentState()

PaymentState before the Change Payment State update action.

Returns:

oldPaymentState

build

public OrderPaymentStateChangedMessage build()

builds OrderPaymentStateChangedMessage with checking for non-null required values

Specified by:

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

Returns:

OrderPaymentStateChangedMessage

buildUnchecked

public OrderPaymentStateChangedMessage buildUnchecked()

builds OrderPaymentStateChangedMessage without checking for non-null required values

Returns:

OrderPaymentStateChangedMessage

of

public static OrderPaymentStateChangedMessageBuilder of()

factory method for an instance of OrderPaymentStateChangedMessageBuilder

Returns:

builder

of

public static OrderPaymentStateChangedMessageBuilder of(OrderPaymentStateChangedMessage template)

create builder for OrderPaymentStateChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder