Package com.commercetools.api.models.message

Class CustomerAddressCustomFieldChangedMessageBuilder

java.lang.Object

com.commercetools.api.models.message.CustomerAddressCustomFieldChangedMessageBuilder

All Implemented Interfaces:

Builder<CustomerAddressCustomFieldChangedMessage>

public class CustomerAddressCustomFieldChangedMessageBuilder
extends Object
implements Builder<CustomerAddressCustomFieldChangedMessage>

CustomerAddressCustomFieldChangedMessageBuilder Example to create an instance using the builder pattern

     CustomerAddressCustomFieldChangedMessage customerAddressCustomFieldChangedMessage = CustomerAddressCustomFieldChangedMessage.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
CustomerAddressCustomFieldChangedMessageBuilder()

Method Summary

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

CustomerAddressCustomFieldChangedMessageBuilder

public CustomerAddressCustomFieldChangedMessageBuilder()

Method Details

id

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

Date and time (UTC) the Message was generated.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public CustomerAddressCustomFieldChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Value of createdAt.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

IDs and references that last modified the Message.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

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

IDs and references that created the Message.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public CustomerAddressCustomFieldChangedMessageBuilder createdBy(@Nullable
 CreatedBy createdBy)

IDs and references that created the Message.

Parameters:

createdBy - value to be set

Returns:

Builder

sequenceNumber

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

Name of the Custom Field that changed.

Parameters:

name - value to be set

Returns:

Builder

value

public CustomerAddressCustomFieldChangedMessageBuilder value(Object value)

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

Parameters:

value - value to be set

Returns:

Builder

previousValue

public CustomerAddressCustomFieldChangedMessageBuilder 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 Address before, a Customer Address Custom Field Added Message is generated instead.

Parameters:

previousValue - value to be set

Returns:

Builder

addressId

public CustomerAddressCustomFieldChangedMessageBuilder addressId(@Nullable
 String addressId)

id of the Address of which the Custom Field was changed.

Parameters:

addressId - 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 Customer Address before, a Customer Address Custom Field Added Message is generated instead.

Returns:

previousValue

getAddressId

@Nullable
public String getAddressId()

id of the Address of which the Custom Field was changed.

Returns:

addressId

build

public CustomerAddressCustomFieldChangedMessage build()

builds CustomerAddressCustomFieldChangedMessage with checking for non-null required values

Specified by:

build in interface Builder<CustomerAddressCustomFieldChangedMessage>

Returns:

CustomerAddressCustomFieldChangedMessage

buildUnchecked

public CustomerAddressCustomFieldChangedMessage buildUnchecked()

builds CustomerAddressCustomFieldChangedMessage without checking for non-null required values

Returns:

CustomerAddressCustomFieldChangedMessage

of

public static CustomerAddressCustomFieldChangedMessageBuilder of()

factory method for an instance of CustomerAddressCustomFieldChangedMessageBuilder

Returns:

builder

of

public static CustomerAddressCustomFieldChangedMessageBuilder of(CustomerAddressCustomFieldChangedMessage template)

create builder for CustomerAddressCustomFieldChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder