Package com.commercetools.api.models.message

Class ReviewRatingSetMessageBuilder

java.lang.Object
com.commercetools.api.models.message.ReviewRatingSetMessageBuilder
All Implemented Interfaces:
Builder<ReviewRatingSetMessage>
public class ReviewRatingSetMessageBuilder extends Object implements Builder<ReviewRatingSetMessage>
ReviewRatingSetMessageBuilder
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 Details

    • ReviewRatingSetMessageBuilder

      public ReviewRatingSetMessageBuilder()

  • Method Details

    • id

      public ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ReviewRatingSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder 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 ReviewRatingSetMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public ReviewRatingSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • oldRating

      public ReviewRatingSetMessageBuilder oldRating(@Nullable Double oldRating)

      The rating of the Review before the Set Rating update action.

      Parameters:
      oldRating - value to be set
      Returns:
      Builder

    • newRating

      public ReviewRatingSetMessageBuilder newRating(@Nullable Double newRating)

      The rating of the Review after the Set Rating update action.

      Parameters:
      newRating - value to be set
      Returns:
      Builder

    • includedInStatistics

      public ReviewRatingSetMessageBuilder includedInStatistics(Boolean includedInStatistics)

      Whether the Review was taken into account in the ratings statistics of the target.

      Parameters:
      includedInStatistics - value to be set
      Returns:
      Builder

    • target

      public ReviewRatingSetMessageBuilder target(@Nullable Reference target)

      Reference to the resource that the Review belongs to.

      Parameters:
      target - value to be set
      Returns:
      Builder

    • target

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

    • 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

    • getOldRating

      @Nullable public Double getOldRating()

      The rating of the Review before the Set Rating update action.

      Returns:
      oldRating

    • getNewRating

      @Nullable public Double getNewRating()

      The rating of the Review after the Set Rating update action.

      Returns:
      newRating

    • getIncludedInStatistics

      public Boolean getIncludedInStatistics()

      Whether the Review was taken into account in the ratings statistics of the target.

      Returns:
      includedInStatistics

    • getTarget

      @Nullable public Reference getTarget()

      Reference to the resource that the Review belongs to.

      Returns:
      target

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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