Class BusinessUnitStoresSetMessageBuilder
- All Implemented Interfaces:
Builder<BusinessUnitStoresSetMessage>
Example to create an instance using the builder pattern
BusinessUnitStoresSetMessage businessUnitStoresSetMessage = BusinessUnitStoresSetMessage.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)
.plusStores(storesBuilder -> storesBuilder)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionStores of the Business Unit after the Set Stores update action.build()
builds BusinessUnitStoresSetMessage with checking for non-null required valuesbuilds BusinessUnitStoresSetMessage without checking for non-null required valuescreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Message was generated.IDs and references that created the Message.createdBy
(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Message.Date and time (UTC) the Message was generated.IDs and references that created the Message.getId()
Unique identifier of the Message.Value ofcreatedAt
.IDs and references that last modified the Message.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.Stores of the Business Unit after the Set Stores update action.Version of a resource.Unique identifier of the Message.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) IDs and references that last modified the Message.IDs and references that last modified the Message.of()
factory method for an instance of BusinessUnitStoresSetMessageBuilderof
(BusinessUnitStoresSetMessage template) create builder for BusinessUnitStoresSetMessage instanceplusStores
(StoreKeyReference... stores) Stores of the Business Unit after the Set Stores update action.Stores of the Business Unit after the Set Stores update action.Reference to the resource on which the change or action was performed.resource
(Function<ReferenceBuilder, 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.Stores of the Business Unit after the Set Stores update action.stores
(StoreKeyReference... stores) Stores of the Business Unit after the Set Stores update action.stores
(List<StoreKeyReference> stores) Stores of the Business Unit after the Set Stores update action.Version of a resource.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) IDs and references that created the Message.IDs and references that last modified the Message.withResourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askey
orexternalId
.Stores of the Business Unit after the Set Stores update action.
-
Constructor Details
-
BusinessUnitStoresSetMessageBuilder
public BusinessUnitStoresSetMessageBuilder()
-
-
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 BusinessUnitStoresSetMessageBuilder 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 BusinessUnitStoresSetMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder, LastModifiedBy> builder) IDs and references that last modified the Message.
- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
lastModifiedBy
IDs and references that last modified the Message.
- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
public BusinessUnitStoresSetMessageBuilder createdBy(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Message.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
withCreatedBy
public BusinessUnitStoresSetMessageBuilder withCreatedBy(Function<CreatedByBuilder, CreatedBy> builder) IDs and references that created the Message.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
createdBy
IDs and references that created the Message.
- 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 BusinessUnitStoresSetMessageBuilder 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
Version of the resource on which the change or action was performed.
- Parameters:
resourceVersion
- value to be set- Returns:
- Builder
-
resourceUserProvidedIdentifiers
public BusinessUnitStoresSetMessageBuilder 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 BusinessUnitStoresSetMessageBuilder 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 BusinessUnitStoresSetMessageBuilder 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
-
stores
Stores of the Business Unit after the Set Stores update action.
- Parameters:
stores
- value to be set- Returns:
- Builder
-
stores
Stores of the Business Unit after the Set Stores update action.
- Parameters:
stores
- value to be set- Returns:
- Builder
-
plusStores
Stores of the Business Unit after the Set Stores update action.
- Parameters:
stores
- value to be set- Returns:
- Builder
-
plusStores
public BusinessUnitStoresSetMessageBuilder plusStores(Function<StoreKeyReferenceBuilder, StoreKeyReferenceBuilder> builder) Stores of the Business Unit after the Set Stores update action.
- Parameters:
builder
- function to build the stores value- Returns:
- Builder
-
withStores
public BusinessUnitStoresSetMessageBuilder withStores(Function<StoreKeyReferenceBuilder, StoreKeyReferenceBuilder> builder) Stores of the Business Unit after the Set Stores update action.
- Parameters:
builder
- function to build the stores value- Returns:
- Builder
-
addStores
public BusinessUnitStoresSetMessageBuilder addStores(Function<StoreKeyReferenceBuilder, StoreKeyReference> builder) Stores of the Business Unit after the Set Stores update action.
- Parameters:
builder
- function to build the stores value- Returns:
- Builder
-
setStores
public BusinessUnitStoresSetMessageBuilder setStores(Function<StoreKeyReferenceBuilder, StoreKeyReference> builder) Stores of the Business Unit after the Set Stores update action.
- Parameters:
builder
- function to build the stores value- 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
IDs and references that last modified the Message.
- Returns:
- lastModifiedBy
-
getCreatedBy
IDs and references that created the Message.
- 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
-
getStores
Stores of the Business Unit after the Set Stores update action.
- Returns:
- stores
-
build
builds BusinessUnitStoresSetMessage with checking for non-null required values- Specified by:
build
in interfaceBuilder<BusinessUnitStoresSetMessage>
- Returns:
- BusinessUnitStoresSetMessage
-
buildUnchecked
builds BusinessUnitStoresSetMessage without checking for non-null required values- Returns:
- BusinessUnitStoresSetMessage
-
of
factory method for an instance of BusinessUnitStoresSetMessageBuilder- Returns:
- builder
-
of
create builder for BusinessUnitStoresSetMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-