Class ReturnInfoSetMessageBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<ReturnInfoSetMessage>
Example to create an instance using the builder pattern
ReturnInfoSetMessage returnInfoSetMessage = ReturnInfoSetMessage.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)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddReturnInfo
(Function<ReturnInfoBuilder, ReturnInfo> builder) The ReturnInfo that was set on the Order or Order Edit.build()
builds ReturnInfoSetMessage with checking for non-null required valuesbuilds ReturnInfoSetMessage 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
.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.The ReturnInfo that was set on the Order or Order Edit.Message number in relation to other Messages for a given resource.Version of a resource.Unique identifier of the Message.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) Value ofcreatedBy
.Value ofcreatedBy
.static ReturnInfoSetMessageBuilder
of()
factory method for an instance of ReturnInfoSetMessageBuilderstatic ReturnInfoSetMessageBuilder
of
(ReturnInfoSetMessage template) create builder for ReturnInfoSetMessage instanceplusReturnInfo
(ReturnInfo... returnInfo) The ReturnInfo that was set on the Order or Order Edit.The ReturnInfo that was set on the Order or Order Edit.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.returnInfo
(ReturnInfo... returnInfo) The ReturnInfo that was set on the Order or Order Edit.returnInfo
(List<ReturnInfo> returnInfo) The ReturnInfo that was set on the Order or Order Edit.sequenceNumber
(Long sequenceNumber) Message number in relation to other Messages for a given resource.setReturnInfo
(Function<ReturnInfoBuilder, ReturnInfo> builder) The ReturnInfo that was set on the Order or Order Edit.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
.The ReturnInfo that was set on the Order or Order Edit.
-
Constructor Details
-
ReturnInfoSetMessageBuilder
public ReturnInfoSetMessageBuilder()
-
-
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 ReturnInfoSetMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder, LastModifiedByBuilder> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
withLastModifiedBy
public ReturnInfoSetMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder, LastModifiedBy> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
lastModifiedBy
Value of
createdBy
.- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
withCreatedBy
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 ReturnInfoSetMessageBuilder 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 ReturnInfoSetMessageBuilder 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 ReturnInfoSetMessageBuilder 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 ReturnInfoSetMessageBuilder 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
-
returnInfo
The ReturnInfo that was set on the Order or Order Edit.
- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
returnInfo
The ReturnInfo that was set on the Order or Order Edit.
- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
plusReturnInfo
The ReturnInfo that was set on the Order or Order Edit.
- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
plusReturnInfo
public ReturnInfoSetMessageBuilder plusReturnInfo(Function<ReturnInfoBuilder, ReturnInfoBuilder> builder) The ReturnInfo that was set on the Order or Order Edit.
- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
withReturnInfo
public ReturnInfoSetMessageBuilder withReturnInfo(Function<ReturnInfoBuilder, ReturnInfoBuilder> builder) The ReturnInfo that was set on the Order or Order Edit.
- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
addReturnInfo
The ReturnInfo that was set on the Order or Order Edit.
- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
setReturnInfo
The ReturnInfo that was set on the Order or Order Edit.
- Parameters:
builder
- function to build the returnInfo 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
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
-
getReturnInfo
The ReturnInfo that was set on the Order or Order Edit.
- Returns:
- returnInfo
-
build
builds ReturnInfoSetMessage with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<ReturnInfoSetMessage>
- Returns:
- ReturnInfoSetMessage
-
buildUnchecked
builds ReturnInfoSetMessage without checking for non-null required values- Returns:
- ReturnInfoSetMessage
-
of
factory method for an instance of ReturnInfoSetMessageBuilder- Returns:
- builder
-
of
create builder for ReturnInfoSetMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-