Package com.commercetools.api.models.message

Class ReturnInfoAddedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.ReturnInfoAddedMessageBuilder

All Implemented Interfaces:

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

public class ReturnInfoAddedMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<ReturnInfoAddedMessage>

ReturnInfoAddedMessageBuilder Example to create an instance using the builder pattern

     ReturnInfoAddedMessage returnInfoAddedMessage = ReturnInfoAddedMessage.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)
             .returnInfo(returnInfoBuilder -> returnInfoBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ReturnInfoAddedMessageBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ReturnInfoAddedMessageBuilder

public ReturnInfoAddedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public ReturnInfoAddedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public ReturnInfoAddedMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

returnInfo

public ReturnInfoAddedMessageBuilder returnInfo(Function<ReturnInfoBuilder,ReturnInfoBuilder> builder)

The ReturnInfo that was added to the Order.

Parameters:

builder - function to build the returnInfo value

Returns:

Builder

withReturnInfo

public ReturnInfoAddedMessageBuilder withReturnInfo(Function<ReturnInfoBuilder,ReturnInfo> builder)

The ReturnInfo that was added to the Order.

Parameters:

builder - function to build the returnInfo value

Returns:

Builder

returnInfo

public ReturnInfoAddedMessageBuilder returnInfo(ReturnInfo returnInfo)

The ReturnInfo that was added to the Order.

Parameters:

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

getReturnInfo

public ReturnInfo getReturnInfo()

The ReturnInfo that was added to the Order.

Returns:

returnInfo

build

public ReturnInfoAddedMessage build()

builds ReturnInfoAddedMessage with checking for non-null required values

Specified by:

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

Returns:

ReturnInfoAddedMessage

buildUnchecked

public ReturnInfoAddedMessage buildUnchecked()

builds ReturnInfoAddedMessage without checking for non-null required values

Returns:

ReturnInfoAddedMessage

of

public static ReturnInfoAddedMessageBuilder of()

factory method for an instance of ReturnInfoAddedMessageBuilder

Returns:

builder

of

public static ReturnInfoAddedMessageBuilder of(ReturnInfoAddedMessage template)

create builder for ReturnInfoAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder