Class CustomerAddressCustomFieldChangedMessageBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<CustomerAddressCustomFieldChangedMessage>
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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds CustomerAddressCustomFieldChangedMessage with checking for non-null required valuesbuilds CustomerAddressCustomFieldChangedMessage without checking for non-null required valuescreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Message was generated.Present on resources created after 1 February 2019 except for events not tracked.createdBy
(Function<CreatedByBuilder, CreatedByBuilder> builder) Present on resources created after 1 February 2019 except for events not tracked.Date and time (UTC) the Message was generated.Present on resources created after 1 February 2019 except for events not tracked.getId()
Unique identifier of the Message.Value ofcreatedAt
.Value ofcreatedBy
.getName()
Name of the Custom Field that has been changed.CustomFieldValue based on the FieldType before the Set CustomField update action.Reference to the resource on which the change or action was performed.User-provided identifiers of the resource, such askey
orexternalId
.Version of the resource on which the change or action was performed.Message number in relation to other Messages for a given resource.getValue()
CustomFieldValue based on the FieldType after the Set Custom Field update action.Version of a resource.Unique identifier of the Message.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) Value ofcreatedBy
.Value ofcreatedBy
.Name of the Custom Field that has been changed.of()
factory method for an instance of CustomerAddressCustomFieldChangedMessageBuilderof
(CustomerAddressCustomFieldChangedMessage template) create builder for CustomerAddressCustomFieldChangedMessage instancepreviousValue
(Object previousValue) CustomFieldValue based on the FieldType before the Set CustomField update action.Reference to the resource on which the change or action was performed.resource
(Function<ReferenceBuilder, io.vrap.rmf.base.client.Builder<? extends Reference>> builder) Reference to the resource on which the change or action was performed.resourceUserProvidedIdentifiers
(UserProvidedIdentifiers resourceUserProvidedIdentifiers) User-provided identifiers of the resource, such askey
orexternalId
.resourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiersBuilder> builder) User-provided identifiers of the resource, such askey
orexternalId
.resourceVersion
(Long resourceVersion) Version of the resource on which the change or action was performed.sequenceNumber
(Long sequenceNumber) Message number in relation to other Messages for a given resource.CustomFieldValue based on the FieldType after the Set Custom Field update action.Version of a resource.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) Present on resources created after 1 February 2019 except for events not tracked.Value ofcreatedBy
.withResourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askey
orexternalId
.
-
Constructor Details
-
CustomerAddressCustomFieldChangedMessageBuilder
-
-
Method Details
-
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
Version of a resource. In case of Messages, this is always
1
.- Parameters:
version
- value to be set- Returns:
- Builder
-
createdAt
Date and time (UTC) the Message was generated.
- Parameters:
createdAt
- value to be set- Returns:
- Builder
-
lastModifiedAt
Value of
createdAt
.- Parameters:
lastModifiedAt
- value to be set- Returns:
- Builder
-
lastModifiedBy
public CustomerAddressCustomFieldChangedMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder, LastModifiedByBuilder> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
withLastModifiedBy
public CustomerAddressCustomFieldChangedMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder, LastModifiedBy> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
lastModifiedBy
public CustomerAddressCustomFieldChangedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy) Value of
createdBy
.- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
public CustomerAddressCustomFieldChangedMessageBuilder 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 CustomerAddressCustomFieldChangedMessageBuilder 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
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
createdBy
- value to be set- Returns:
- Builder
-
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 thesequenceNumber
of the current Message. Meaning, thesequenceNumber
of the next Message equals thesequenceNumber
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
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, 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
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
orexternalId
. 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
orexternalId
. 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
orexternalId
. Only present if the resource has such identifiers.- Parameters:
resourceUserProvidedIdentifiers
- value to be set- Returns:
- Builder
-
name
Name of the Custom Field that has been changed.
- Parameters:
name
- value to be set- Returns:
- Builder
-
value
CustomFieldValue based on the FieldType after the Set Custom Field 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
-
getId
Unique identifier of the Message. Can be used to track which Messages have been processed.
- Returns:
- id
-
getVersion
Version of a resource. In case of Messages, this is always
1
.- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Message was generated.
- Returns:
- createdAt
-
getLastModifiedAt
Value of
createdAt
.- Returns:
- lastModifiedAt
-
getLastModifiedBy
Value of
createdBy
.- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Returns:
- createdBy
-
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 thesequenceNumber
of the current Message. Meaning, thesequenceNumber
of the next Message equals thesequenceNumber
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
Reference to the resource on which the change or action was performed.
- Returns:
- resource
-
getResourceVersion
Version of the resource on which the change or action was performed.
- Returns:
- resourceVersion
-
getResourceUserProvidedIdentifiers
User-provided identifiers of the resource, such as
key
orexternalId
. Only present if the resource has such identifiers.- Returns:
- resourceUserProvidedIdentifiers
-
getName
Name of the Custom Field that has been changed.
- Returns:
- name
-
getValue
CustomFieldValue based on the FieldType after the Set Custom Field update action.
- Returns:
- value
-
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
-
build
builds CustomerAddressCustomFieldChangedMessage with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<CustomerAddressCustomFieldChangedMessage>
- Returns:
- CustomerAddressCustomFieldChangedMessage
-
buildUnchecked
builds CustomerAddressCustomFieldChangedMessage without checking for non-null required values- Returns:
- CustomerAddressCustomFieldChangedMessage
-
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
-