Package com.commercetools.api.models.message

Class RecurringOrderCustomFieldChangedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.RecurringOrderCustomFieldChangedMessageBuilder

All Implemented Interfaces:

Builder<RecurringOrderCustomFieldChangedMessage>

public class RecurringOrderCustomFieldChangedMessageBuilder
extends Object
implements Builder<RecurringOrderCustomFieldChangedMessage>

RecurringOrderCustomFieldChangedMessageBuilder Example to create an instance using the builder pattern

     RecurringOrderCustomFieldChangedMessage recurringOrderCustomFieldChangedMessage = RecurringOrderCustomFieldChangedMessage.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)
             .name("{name}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
RecurringOrderCustomFieldChangedMessageBuilder()

Method Summary

Modifier and Type	Method	Description
RecurringOrderCustomFieldChangedMessage	build()	builds RecurringOrderCustomFieldChangedMessage with checking for non-null required values
RecurringOrderCustomFieldChangedMessage	buildUnchecked()	builds RecurringOrderCustomFieldChangedMessage without checking for non-null required values
RecurringOrderCustomFieldChangedMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
RecurringOrderCustomFieldChangedMessageBuilder	createdBy(CreatedBy createdBy)	IDs and references that created the Message.
RecurringOrderCustomFieldChangedMessageBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	IDs and references that created the Message.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Message was generated.
CreatedBy	getCreatedBy()	IDs and references that created the Message.
String	getId()	Unique identifier of the Message.
ZonedDateTime	getLastModifiedAt()	Value of createdAt.
LastModifiedBy	getLastModifiedBy()	IDs and references that last modified the Message.
String	getName()	Name of the Custom Field that changed.
Object	getPreviousValue()	CustomFieldValue based on the FieldType before the Set CustomField 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.
Object	getValue()	CustomFieldValue based on the FieldType after the Set CustomField update action.
Long	getVersion()	Version of a resource.
RecurringOrderCustomFieldChangedMessageBuilder	id(String id)	Unique identifier of the Message.
RecurringOrderCustomFieldChangedMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
RecurringOrderCustomFieldChangedMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	IDs and references that last modified the Message.
RecurringOrderCustomFieldChangedMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	IDs and references that last modified the Message.
RecurringOrderCustomFieldChangedMessageBuilder	name(String name)	Name of the Custom Field that changed.
static RecurringOrderCustomFieldChangedMessageBuilder	of()	factory method for an instance of RecurringOrderCustomFieldChangedMessageBuilder
static RecurringOrderCustomFieldChangedMessageBuilder	of(RecurringOrderCustomFieldChangedMessage template)	create builder for RecurringOrderCustomFieldChangedMessage instance
RecurringOrderCustomFieldChangedMessageBuilder	previousValue(Object previousValue)	CustomFieldValue based on the FieldType before the Set CustomField update action.
RecurringOrderCustomFieldChangedMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
RecurringOrderCustomFieldChangedMessageBuilder	resource(Function<ReferenceBuilder,Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
RecurringOrderCustomFieldChangedMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
RecurringOrderCustomFieldChangedMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
RecurringOrderCustomFieldChangedMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
RecurringOrderCustomFieldChangedMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
RecurringOrderCustomFieldChangedMessageBuilder	value(Object value)	CustomFieldValue based on the FieldType after the Set CustomField update action.
RecurringOrderCustomFieldChangedMessageBuilder	version(Long version)	Version of a resource.
RecurringOrderCustomFieldChangedMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	IDs and references that created the Message.
RecurringOrderCustomFieldChangedMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	IDs and references that last modified the Message.
RecurringOrderCustomFieldChangedMessageBuilder	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

RecurringOrderCustomFieldChangedMessageBuilder

public RecurringOrderCustomFieldChangedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public RecurringOrderCustomFieldChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public RecurringOrderCustomFieldChangedMessageBuilder 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 RecurringOrderCustomFieldChangedMessageBuilder 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 RecurringOrderCustomFieldChangedMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

IDs and references that last modified the Message.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public RecurringOrderCustomFieldChangedMessageBuilder createdBy(@Nullable
 CreatedBy createdBy)

IDs and references that created the Message.

Parameters:

createdBy - value to be set

Returns:

Builder

sequenceNumber

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

name

public RecurringOrderCustomFieldChangedMessageBuilder name(String name)

Name of the Custom Field that changed.

Parameters:

name - value to be set

Returns:

Builder

value

public RecurringOrderCustomFieldChangedMessageBuilder value(Object value)

CustomFieldValue based on the FieldType after the Set CustomField update action.

Parameters:

value - value to be set

Returns:

Builder

previousValue

public RecurringOrderCustomFieldChangedMessageBuilder previousValue(@Nullable
 Object previousValue)

CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.

Parameters:

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

getName

public String getName()

Name of the Custom Field that changed.

Returns:

name

getValue

public Object getValue()

CustomFieldValue based on the FieldType after the Set CustomField update action.

Returns:

value

getPreviousValue

@Nullable
public Object getPreviousValue()

CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.

Returns:

previousValue

build

public RecurringOrderCustomFieldChangedMessage build()

builds RecurringOrderCustomFieldChangedMessage with checking for non-null required values

Specified by:

build in interface Builder<RecurringOrderCustomFieldChangedMessage>

Returns:

RecurringOrderCustomFieldChangedMessage

buildUnchecked

public RecurringOrderCustomFieldChangedMessage buildUnchecked()

builds RecurringOrderCustomFieldChangedMessage without checking for non-null required values

Returns:

RecurringOrderCustomFieldChangedMessage

of

public static RecurringOrderCustomFieldChangedMessageBuilder of()

factory method for an instance of RecurringOrderCustomFieldChangedMessageBuilder

Returns:

builder

of

public static RecurringOrderCustomFieldChangedMessageBuilder of(RecurringOrderCustomFieldChangedMessage template)

create builder for RecurringOrderCustomFieldChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder