Class CustomLineItemStateTransitionMessageBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<CustomLineItemStateTransitionMessage>
Example to create an instance using the builder pattern
CustomLineItemStateTransitionMessage customLineItemStateTransitionMessage = CustomLineItemStateTransitionMessage.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)
.customLineItemId("{customLineItemId}")
.transitionDate(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.quantity(0.3)
.fromState(fromStateBuilder -> fromStateBuilder)
.toState(toStateBuilder -> toStateBuilder)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds CustomLineItemStateTransitionMessage with checking for non-null required valuesbuilds CustomLineItemStateTransitionMessage 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.customLineItemId
(String customLineItemId) Unique identifier of the Custom Line Item.fromState
(StateReference fromState) State the Custom Line Item was transitioned from.State the Custom Line Item was transitioned from.Date and time (UTC) the Message was generated.Present on resources created after 1 February 2019 except for events not tracked.Unique identifier of the Custom Line Item.State the Custom Line Item was transitioned from.getId()
Unique identifier of the Message.Value ofcreatedAt
.Value ofcreatedBy
.Number of Custom Line Items for which the State was transitioned.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.State the Custom Line Item was transitioned to.Date and time (UTC) when the transition of the Custom Line Item State was performed.Version of a resource.Unique identifier of the Message.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) Value ofcreatedBy
.Value ofcreatedBy
.of()
factory method for an instance of CustomLineItemStateTransitionMessageBuilderof
(CustomLineItemStateTransitionMessage template) create builder for CustomLineItemStateTransitionMessage instanceNumber of Custom Line Items for which the State was transitioned.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.toState
(StateReference toState) State the Custom Line Item was transitioned to.State the Custom Line Item was transitioned to.transitionDate
(ZonedDateTime transitionDate) Date and time (UTC) when the transition of the Custom Line Item State was performed.Version of a resource.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) Present on resources created after 1 February 2019 except for events not tracked.State the Custom Line Item was transitioned from.Value ofcreatedBy
.withResourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askey
orexternalId
.State the Custom Line Item was transitioned to.
-
Constructor Details
-
CustomLineItemStateTransitionMessageBuilder
-
-
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 CustomLineItemStateTransitionMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder, LastModifiedByBuilder> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
withLastModifiedBy
public CustomLineItemStateTransitionMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder, LastModifiedBy> builder) Value of
createdBy
.- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
lastModifiedBy
public CustomLineItemStateTransitionMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy) Value of
createdBy
.- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
public CustomLineItemStateTransitionMessageBuilder 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 CustomLineItemStateTransitionMessageBuilder 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 CustomLineItemStateTransitionMessageBuilder 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 CustomLineItemStateTransitionMessageBuilder 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 CustomLineItemStateTransitionMessageBuilder 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 CustomLineItemStateTransitionMessageBuilder 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
-
customLineItemId
Unique identifier of the Custom Line Item.
- Parameters:
customLineItemId
- value to be set- Returns:
- Builder
-
transitionDate
Date and time (UTC) when the transition of the Custom Line Item State was performed.
- Parameters:
transitionDate
- value to be set- Returns:
- Builder
-
quantity
Number of Custom Line Items for which the State was transitioned.
- Parameters:
quantity
- value to be set- Returns:
- Builder
-
fromState
public CustomLineItemStateTransitionMessageBuilder fromState(Function<StateReferenceBuilder, StateReferenceBuilder> builder) State the Custom Line Item was transitioned from.
- Parameters:
builder
- function to build the fromState value- Returns:
- Builder
-
withFromState
public CustomLineItemStateTransitionMessageBuilder withFromState(Function<StateReferenceBuilder, StateReference> builder) State the Custom Line Item was transitioned from.
- Parameters:
builder
- function to build the fromState value- Returns:
- Builder
-
fromState
State the Custom Line Item was transitioned from.
- Parameters:
fromState
- value to be set- Returns:
- Builder
-
toState
public CustomLineItemStateTransitionMessageBuilder toState(Function<StateReferenceBuilder, StateReferenceBuilder> builder) State the Custom Line Item was transitioned to.
- Parameters:
builder
- function to build the toState value- Returns:
- Builder
-
withToState
public CustomLineItemStateTransitionMessageBuilder withToState(Function<StateReferenceBuilder, StateReference> builder) State the Custom Line Item was transitioned to.
- Parameters:
builder
- function to build the toState value- Returns:
- Builder
-
toState
State the Custom Line Item was transitioned to.
- Parameters:
toState
- 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
-
getCustomLineItemId
Unique identifier of the Custom Line Item.
- Returns:
- customLineItemId
-
getTransitionDate
Date and time (UTC) when the transition of the Custom Line Item State was performed.
- Returns:
- transitionDate
-
getQuantity
Number of Custom Line Items for which the State was transitioned.
- Returns:
- quantity
-
getFromState
State the Custom Line Item was transitioned from.
- Returns:
- fromState
-
getToState
State the Custom Line Item was transitioned to.
- Returns:
- toState
-
build
builds CustomLineItemStateTransitionMessage with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<CustomLineItemStateTransitionMessage>
- Returns:
- CustomLineItemStateTransitionMessage
-
buildUnchecked
builds CustomLineItemStateTransitionMessage without checking for non-null required values- Returns:
- CustomLineItemStateTransitionMessage
-
of
factory method for an instance of CustomLineItemStateTransitionMessageBuilder- Returns:
- builder
-
of
public static CustomLineItemStateTransitionMessageBuilder of(CustomLineItemStateTransitionMessage template) create builder for CustomLineItemStateTransitionMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-