Class MessagePagedQueryResponseBuilder

java.lang.Object
com.commercetools.api.models.message.MessagePagedQueryResponseBuilder
All Implemented Interfaces:
Builder<MessagePagedQueryResponse>

public class MessagePagedQueryResponseBuilder extends Object implements Builder<MessagePagedQueryResponse>
MessagePagedQueryResponseBuilder
Example to create an instance using the builder pattern

     MessagePagedQueryResponse messagePagedQueryResponse = MessagePagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 
  • Constructor Details

    • MessagePagedQueryResponseBuilder

      public MessagePagedQueryResponseBuilder()
  • Method Details

    • limit

      public MessagePagedQueryResponseBuilder limit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set
      Returns:
      Builder
    • count

      public MessagePagedQueryResponseBuilder count(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set
      Returns:
      Builder
    • 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 MessagePagedQueryResponseBuilder offset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set
      Returns:
      Builder
    • results

      public MessagePagedQueryResponseBuilder results(Message... results)

      Messages matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder
    • results

      public MessagePagedQueryResponseBuilder results(List<Message> results)

      Messages matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder
    • plusResults

      public MessagePagedQueryResponseBuilder plusResults(Message... results)

      Messages matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder
    • plusResults

      public MessagePagedQueryResponseBuilder plusResults(Function<MessageBuilder,Builder<? extends Message>> builder)

      Messages matching the query.

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

      public MessagePagedQueryResponseBuilder withResults(Function<MessageBuilder,Builder<? extends Message>> builder)

      Messages 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<Message> getResults()

      Messages matching the query.

      Returns:
      results
    • build

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

      public MessagePagedQueryResponse buildUnchecked()
      builds MessagePagedQueryResponse without checking for non-null required values
      Returns:
      MessagePagedQueryResponse
    • of

      factory method for an instance of MessagePagedQueryResponseBuilder
      Returns:
      builder
    • of

      create builder for MessagePagedQueryResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder