Package com.commercetools.api.models.review

Class ReviewPagedQueryResponseBuilder

java.lang.Object
com.commercetools.api.models.review.ReviewPagedQueryResponseBuilder
All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<ReviewPagedQueryResponse>
public class ReviewPagedQueryResponseBuilder extends Object implements io.vrap.rmf.base.client.Builder<ReviewPagedQueryResponse>
ReviewPagedQueryResponseBuilder
Example to create an instance using the builder pattern 

     ReviewPagedQueryResponse reviewPagedQueryResponse = ReviewPagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Constructor Details

    • ReviewPagedQueryResponseBuilder

      public ReviewPagedQueryResponseBuilder()

  • Method Details

    • limit

      public ReviewPagedQueryResponseBuilder limit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set
      Returns:
      Builder

    • count

      public ReviewPagedQueryResponseBuilder count(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set
      Returns:
      Builder

    • total

      public ReviewPagedQueryResponseBuilder total(@Nullable Long total)

      Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

      Parameters:
      total - value to be set
      Returns:
      Builder

    • offset

      public ReviewPagedQueryResponseBuilder offset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set
      Returns:
      Builder

    • results

      public ReviewPagedQueryResponseBuilder results(Review... results)

      Reviews matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • results

      public ReviewPagedQueryResponseBuilder results(List<Review> results)

      Reviews matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public ReviewPagedQueryResponseBuilder plusResults(Review... results)

      Reviews matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public ReviewPagedQueryResponseBuilder plusResults(Function<ReviewBuilder,ReviewBuilder> builder)

      Reviews matching the query.

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

    • withResults

      public ReviewPagedQueryResponseBuilder withResults(Function<ReviewBuilder,ReviewBuilder> builder)

      Reviews matching the query.

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

    • addResults

      public ReviewPagedQueryResponseBuilder addResults(Function<ReviewBuilder,Review> builder)

      Reviews matching the query.

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

    • setResults

      public ReviewPagedQueryResponseBuilder setResults(Function<ReviewBuilder,Review> builder)

      Reviews matching the query.

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

    • getLimit

      public Long getLimit()

      Number of results requested.

      Returns:
      limit

    • getCount

      public Long getCount()

      Actual number of results returned.

      Returns:
      count

    • getTotal

      @Nullable public Long getTotal()

      Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

      Returns:
      total

    • getOffset

      public Long getOffset()

      Number of elements skipped.

      Returns:
      offset

    • getResults

      public List<Review> getResults()

      Reviews matching the query.

      Returns:
      results

    • build

      public ReviewPagedQueryResponse build()
      builds ReviewPagedQueryResponse with checking for non-null required values
      Specified by:
      build in interface io.vrap.rmf.base.client.Builder<ReviewPagedQueryResponse>
      Returns:
      ReviewPagedQueryResponse

    • buildUnchecked

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

    • of

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

    • of

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