Package com.commercetools.api.models.message

Class ReviewStateTransitionMessageBuilder

java.lang.Object
com.commercetools.api.models.message.ReviewStateTransitionMessageBuilder
All Implemented Interfaces:
Builder<ReviewStateTransitionMessage>
public class ReviewStateTransitionMessageBuilder extends Object implements Builder<ReviewStateTransitionMessage>
ReviewStateTransitionMessageBuilder
Example to create an instance using the builder pattern 

     ReviewStateTransitionMessage reviewStateTransitionMessage = ReviewStateTransitionMessage.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)
             .newState(newStateBuilder -> newStateBuilder)
             .oldIncludedInStatistics(true)
             .newIncludedInStatistics(true)
             .force(true)
             .build()

  • Constructor Details

    • ReviewStateTransitionMessageBuilder

      public ReviewStateTransitionMessageBuilder()

  • Method Details

    • id

      public ReviewStateTransitionMessageBuilder id(String 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

      public ReviewStateTransitionMessageBuilder version(Long version)

      Version of a resource. In case of Messages, this is always 1.

      Parameters:
      version - value to be set
      Returns:
      Builder

    • createdAt

      public ReviewStateTransitionMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ReviewStateTransitionMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public ReviewStateTransitionMessageBuilder 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 ReviewStateTransitionMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

      IDs and references that last modified the Message.

      Parameters:
      builder - function to build the lastModifiedBy value
      Returns:
      Builder

    • lastModifiedBy

      public ReviewStateTransitionMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

      public ReviewStateTransitionMessageBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder

    • withCreatedBy

      public ReviewStateTransitionMessageBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder

    • createdBy

      public ReviewStateTransitionMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public ReviewStateTransitionMessageBuilder sequenceNumber(Long 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 the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber 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

      public ReviewStateTransitionMessageBuilder resource(Reference resource)

      Reference to the resource on which the change or action was performed.

      Parameters:
      resource - value to be set
      Returns:
      Builder

    • resource

      public ReviewStateTransitionMessageBuilder 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

      public ReviewStateTransitionMessageBuilder resourceVersion(Long resourceVersion)

      Version of the resource on which the change or action was performed.

      Parameters:
      resourceVersion - value to be set
      Returns:
      Builder

    • resourceUserProvidedIdentifiers

      public ReviewStateTransitionMessageBuilder resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder

    • withResourceUserProvidedIdentifiers

      public ReviewStateTransitionMessageBuilder withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder

    • resourceUserProvidedIdentifiers

      public ReviewStateTransitionMessageBuilder resourceUserProvidedIdentifiers(@Nullable UserProvidedIdentifiers resourceUserProvidedIdentifiers)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      resourceUserProvidedIdentifiers - value to be set
      Returns:
      Builder

    • oldState

      public ReviewStateTransitionMessageBuilder oldState(Function<StateReferenceBuilder,StateReferenceBuilder> builder)

      State of the Review before the Transition State update action.

      Parameters:
      builder - function to build the oldState value
      Returns:
      Builder

    • withOldState

      public ReviewStateTransitionMessageBuilder withOldState(Function<StateReferenceBuilder,StateReference> builder)

      State of the Review before the Transition State update action.

      Parameters:
      builder - function to build the oldState value
      Returns:
      Builder

    • oldState

      public ReviewStateTransitionMessageBuilder oldState(@Nullable StateReference oldState)

      State of the Review before the Transition State update action.

      Parameters:
      oldState - value to be set
      Returns:
      Builder

    • newState

      public ReviewStateTransitionMessageBuilder newState(Function<StateReferenceBuilder,StateReferenceBuilder> builder)

      State of the Review after the Transition State update action.

      Parameters:
      builder - function to build the newState value
      Returns:
      Builder

    • withNewState

      public ReviewStateTransitionMessageBuilder withNewState(Function<StateReferenceBuilder,StateReference> builder)

      State of the Review after the Transition State update action.

      Parameters:
      builder - function to build the newState value
      Returns:
      Builder

    • newState

      public ReviewStateTransitionMessageBuilder newState(StateReference newState)

      State of the Review after the Transition State update action.

      Parameters:
      newState - value to be set
      Returns:
      Builder

    • oldIncludedInStatistics

      public ReviewStateTransitionMessageBuilder oldIncludedInStatistics(Boolean oldIncludedInStatistics)

      Whether the old Review was taken into account in the rating statistics of the target before the state transition.

      Parameters:
      oldIncludedInStatistics - value to be set
      Returns:
      Builder

    • newIncludedInStatistics

      public ReviewStateTransitionMessageBuilder newIncludedInStatistics(Boolean newIncludedInStatistics)

      Whether the new Review was taken into account in the rating statistics of the target after the state transition.

      Parameters:
      newIncludedInStatistics - value to be set
      Returns:
      Builder

    • target

      public ReviewStateTransitionMessageBuilder target(@Nullable Reference target)

      Reference to the resource that the Review belongs to.

      Parameters:
      target - value to be set
      Returns:
      Builder

    • target

      public ReviewStateTransitionMessageBuilder target(Function<ReferenceBuilder,Builder<? extends Reference>> builder)

      Reference to the resource that the Review belongs to.

      Parameters:
      builder - function to build the target value
      Returns:
      Builder

    • force

      public ReviewStateTransitionMessageBuilder force(Boolean force)

      Whether State transition validations were turned off during the Transition State update action.

      Parameters:
      force - value to be set
      Returns:
      Builder

    • getId

      public String getId()

      Unique identifier of the Message. Can be used to track which Messages have been processed.

      Returns:
      id

    • getVersion

      public Long getVersion()

      Version of a resource. In case of Messages, this is always 1.

      Returns:
      version

    • getCreatedAt

      public ZonedDateTime getCreatedAt()

      Date and time (UTC) the Message was generated.

      Returns:
      createdAt

    • getLastModifiedAt

      public ZonedDateTime getLastModifiedAt()

      Value of createdAt.

      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Nullable public LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the Message.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Nullable public CreatedBy getCreatedBy()

      IDs and references that created the Message.

      Returns:
      createdBy

    • getSequenceNumber

      public Long 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 the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber 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

      public Reference getResource()

      Reference to the resource on which the change or action was performed.

      Returns:
      resource

    • getResourceVersion

      public Long getResourceVersion()

      Version of the resource on which the change or action was performed.

      Returns:
      resourceVersion

    • getResourceUserProvidedIdentifiers

      @Nullable public UserProvidedIdentifiers getResourceUserProvidedIdentifiers()

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Returns:
      resourceUserProvidedIdentifiers

    • getOldState

      @Nullable public StateReference getOldState()

      State of the Review before the Transition State update action.

      Returns:
      oldState

    • getNewState

      public StateReference getNewState()

      State of the Review after the Transition State update action.

      Returns:
      newState

    • getOldIncludedInStatistics

      public Boolean getOldIncludedInStatistics()

      Whether the old Review was taken into account in the rating statistics of the target before the state transition.

      Returns:
      oldIncludedInStatistics

    • getNewIncludedInStatistics

      public Boolean getNewIncludedInStatistics()

      Whether the new Review was taken into account in the rating statistics of the target after the state transition.

      Returns:
      newIncludedInStatistics

    • getTarget

      @Nullable public Reference getTarget()

      Reference to the resource that the Review belongs to.

      Returns:
      target

    • getForce

      public Boolean getForce()

      Whether State transition validations were turned off during the Transition State update action.

      Returns:
      force

    • build

      public ReviewStateTransitionMessage build()
      builds ReviewStateTransitionMessage with checking for non-null required values
      Specified by:
      build in interface Builder<ReviewStateTransitionMessage>
      Returns:
      ReviewStateTransitionMessage

    • buildUnchecked

      public ReviewStateTransitionMessage buildUnchecked()
      builds ReviewStateTransitionMessage without checking for non-null required values
      Returns:
      ReviewStateTransitionMessage

    • of

      public static ReviewStateTransitionMessageBuilder of()
      factory method for an instance of ReviewStateTransitionMessageBuilder
      Returns:
      builder

    • of

      public static ReviewStateTransitionMessageBuilder of(ReviewStateTransitionMessage template)
      create builder for ReviewStateTransitionMessage instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder