Package com.commercetools.api.models.message

Class OrderReturnShipmentStateChangedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.OrderReturnShipmentStateChangedMessageBuilder

All Implemented Interfaces:

Builder<OrderReturnShipmentStateChangedMessage>

public class OrderReturnShipmentStateChangedMessageBuilder
extends Object
implements Builder<OrderReturnShipmentStateChangedMessage>

OrderReturnShipmentStateChangedMessageBuilder Example to create an instance using the builder pattern

     OrderReturnShipmentStateChangedMessage orderReturnShipmentStateChangedMessage = OrderReturnShipmentStateChangedMessage.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)
             .returnItemId("{returnItemId}")
             .returnShipmentState(ReturnShipmentState.ADVISED)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
OrderReturnShipmentStateChangedMessageBuilder()

Method Summary

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

OrderReturnShipmentStateChangedMessageBuilder

public OrderReturnShipmentStateChangedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public OrderReturnShipmentStateChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

IDs and references that last modified the Message.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public OrderReturnShipmentStateChangedMessageBuilder createdBy(@Nullable
 CreatedBy createdBy)

IDs and references that created the Message.

Parameters:

createdBy - value to be set

Returns:

Builder

sequenceNumber

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

returnItemId

public OrderReturnShipmentStateChangedMessageBuilder returnItemId(String returnItemId)

Unique identifier of the ReturnItem.

Parameters:

returnItemId - value to be set

Returns:

Builder

returnShipmentState

public OrderReturnShipmentStateChangedMessageBuilder returnShipmentState(ReturnShipmentState returnShipmentState)

State of the ReturnItem after the Set Return Shipment State update action.

Parameters:

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

getReturnItemId

public String getReturnItemId()

Unique identifier of the ReturnItem.

Returns:

returnItemId

getReturnShipmentState

public ReturnShipmentState getReturnShipmentState()

State of the ReturnItem after the Set Return Shipment State update action.

Returns:

returnShipmentState

build

public OrderReturnShipmentStateChangedMessage build()

builds OrderReturnShipmentStateChangedMessage with checking for non-null required values

Specified by:

build in interface Builder<OrderReturnShipmentStateChangedMessage>

Returns:

OrderReturnShipmentStateChangedMessage

buildUnchecked

public OrderReturnShipmentStateChangedMessage buildUnchecked()

builds OrderReturnShipmentStateChangedMessage without checking for non-null required values

Returns:

OrderReturnShipmentStateChangedMessage

of

public static OrderReturnShipmentStateChangedMessageBuilder of()

factory method for an instance of OrderReturnShipmentStateChangedMessageBuilder

Returns:

builder

of

public static OrderReturnShipmentStateChangedMessageBuilder of(OrderReturnShipmentStateChangedMessage template)

create builder for OrderReturnShipmentStateChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder