Package com.commercetools.api.models.message

Class CustomerCustomFieldChangedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.CustomerCustomFieldChangedMessageBuilder

All Implemented Interfaces:

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

public class CustomerCustomFieldChangedMessageBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<CustomerCustomFieldChangedMessage>

CustomerCustomFieldChangedMessageBuilder Example to create an instance using the builder pattern

     CustomerCustomFieldChangedMessage customerCustomFieldChangedMessage = CustomerCustomFieldChangedMessage.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
CustomerCustomFieldChangedMessageBuilder()

Method Summary

Modifier and Type	Method	Description
CustomerCustomFieldChangedMessage	build()	builds CustomerCustomFieldChangedMessage with checking for non-null required values
CustomerCustomFieldChangedMessage	buildUnchecked()	builds CustomerCustomFieldChangedMessage without checking for non-null required values
CustomerCustomFieldChangedMessageBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
CustomerCustomFieldChangedMessageBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
CustomerCustomFieldChangedMessageBuilder	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.
String	getName()	Name of the Custom Field that has been 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 Custom Field update action.
Long	getVersion()	Version of a resource.
CustomerCustomFieldChangedMessageBuilder	id(String id)	Unique identifier of the Message.
CustomerCustomFieldChangedMessageBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
CustomerCustomFieldChangedMessageBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Value of createdBy.
CustomerCustomFieldChangedMessageBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Value of createdBy.
CustomerCustomFieldChangedMessageBuilder	name(String name)	Name of the Custom Field that has been changed.
static CustomerCustomFieldChangedMessageBuilder	of()	factory method for an instance of CustomerCustomFieldChangedMessageBuilder
static CustomerCustomFieldChangedMessageBuilder	of(CustomerCustomFieldChangedMessage template)	create builder for CustomerCustomFieldChangedMessage instance
CustomerCustomFieldChangedMessageBuilder	previousValue(Object previousValue)	CustomFieldValue based on the FieldType before the Set CustomField update action.
CustomerCustomFieldChangedMessageBuilder	resource(Reference resource)	Reference to the resource on which the change or action was performed.
CustomerCustomFieldChangedMessageBuilder	resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Reference to the resource on which the change or action was performed.
CustomerCustomFieldChangedMessageBuilder	resourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
CustomerCustomFieldChangedMessageBuilder	resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)	User-provided identifiers of the resource, such as key or externalId.
CustomerCustomFieldChangedMessageBuilder	resourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
CustomerCustomFieldChangedMessageBuilder	sequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
CustomerCustomFieldChangedMessageBuilder	value(Object value)	CustomFieldValue based on the FieldType after the Set Custom Field update action.
CustomerCustomFieldChangedMessageBuilder	version(Long version)	Version of a resource.
CustomerCustomFieldChangedMessageBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
CustomerCustomFieldChangedMessageBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Value of createdBy.
CustomerCustomFieldChangedMessageBuilder	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

CustomerCustomFieldChangedMessageBuilder

public CustomerCustomFieldChangedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public CustomerCustomFieldChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

Value of createdBy.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public CustomerCustomFieldChangedMessageBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Value of createdBy.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder 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 CustomerCustomFieldChangedMessageBuilder name(String name)

Name of the Custom Field that has been changed.

Parameters:

name - value to be set

Returns:

Builder

value

public CustomerCustomFieldChangedMessageBuilder value(Object value)

CustomFieldValue based on the FieldType after the Set Custom Field update action.

Parameters:

value - value to be set

Returns:

Builder

previousValue

public CustomerCustomFieldChangedMessageBuilder 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 Customer before, a Customer 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()

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

getName

public String getName()

Name of the Custom Field that has been changed.

Returns:

name

getValue

public Object getValue()

CustomFieldValue based on the FieldType after the Set Custom Field 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 Customer before, a Customer Custom Field Added Message is generated instead.

Returns:

previousValue

build

public CustomerCustomFieldChangedMessage build()

builds CustomerCustomFieldChangedMessage with checking for non-null required values

Specified by:

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

Returns:

CustomerCustomFieldChangedMessage

buildUnchecked

public CustomerCustomFieldChangedMessage buildUnchecked()

builds CustomerCustomFieldChangedMessage without checking for non-null required values

Returns:

CustomerCustomFieldChangedMessage

of

public static CustomerCustomFieldChangedMessageBuilder of()

factory method for an instance of CustomerCustomFieldChangedMessageBuilder

Returns:

builder

of

public static CustomerCustomFieldChangedMessageBuilder of(CustomerCustomFieldChangedMessage template)

create builder for CustomerCustomFieldChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder