Class ReviewRatingSetMessageBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<ReviewRatingSetMessage>
Example to create an instance using the builder pattern
ReviewRatingSetMessage reviewRatingSetMessage = ReviewRatingSetMessage.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)
.includedInStatistics(true)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds ReviewRatingSetMessage with checking for non-null required valuesbuilds ReviewRatingSetMessage 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.Whether the Review was taken into account in the ratings statistics of the target.Value ofcreatedAt
.Value ofcreatedBy
.Therating
of the Review after the Set Rating update action.Therating
of the Review before the Set Rating 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.Reference to the resource that the Review belongs to.Version of a resource.Unique identifier of the Message.includedInStatistics
(Boolean includedInStatistics) Whether the Review was taken into account in the ratings statistics of the target.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) Value ofcreatedBy
.Value ofcreatedBy
.Therating
of the Review after the Set Rating update action.of()
factory method for an instance of ReviewRatingSetMessageBuilderof
(ReviewRatingSetMessage template) create builder for ReviewRatingSetMessage instanceTherating
of the Review before the Set Rating 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.Reference to the resource that the Review belongs to.target
(Function<ReferenceBuilder, io.vrap.rmf.base.client.Builder<? extends Reference>> builder) Reference to the resource that the Review belongs to.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
-
ReviewRatingSetMessageBuilder
public ReviewRatingSetMessageBuilder()
-
-
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 ReviewRatingSetMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder, LastModifiedByBuilder> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
withLastModifiedBy
public ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder 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
-
oldRating
The
rating
of the Review before the Set Rating update action.- Parameters:
oldRating
- value to be set- Returns:
- Builder
-
newRating
The
rating
of the Review after the Set Rating update action.- Parameters:
newRating
- value to be set- Returns:
- Builder
-
includedInStatistics
Whether the Review was taken into account in the ratings statistics of the target.
- Parameters:
includedInStatistics
- value to be set- Returns:
- Builder
-
target
Reference to the resource that the Review belongs to.
- Parameters:
target
- value to be set- Returns:
- Builder
-
target
public ReviewRatingSetMessageBuilder target(Function<ReferenceBuilder, io.vrap.rmf.base.client.Builder<? extends Reference>> builder) Reference to the resource that the Review belongs to.
- Parameters:
builder
- function to build the target 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
-
getOldRating
The
rating
of the Review before the Set Rating update action.- Returns:
- oldRating
-
getNewRating
The
rating
of the Review after the Set Rating update action.- Returns:
- newRating
-
getIncludedInStatistics
Whether the Review was taken into account in the ratings statistics of the target.
- Returns:
- includedInStatistics
-
getTarget
Reference to the resource that the Review belongs to.
- Returns:
- target
-
build
builds ReviewRatingSetMessage with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<ReviewRatingSetMessage>
- Returns:
- ReviewRatingSetMessage
-
buildUnchecked
builds ReviewRatingSetMessage without checking for non-null required values- Returns:
- ReviewRatingSetMessage
-
of
factory method for an instance of ReviewRatingSetMessageBuilder- Returns:
- builder
-
of
create builder for ReviewRatingSetMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-