Package com.commercetools.api.models.channel

Class ChannelPagedQueryResponseBuilder

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

     ChannelPagedQueryResponse channelPagedQueryResponse = ChannelPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Constructor Details

    • ChannelPagedQueryResponseBuilder

      public ChannelPagedQueryResponseBuilder()

  • Method Details

    • limit

      public ChannelPagedQueryResponseBuilder limit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set
      Returns:
      Builder

    • offset

      public ChannelPagedQueryResponseBuilder offset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set
      Returns:
      Builder

    • count

      public ChannelPagedQueryResponseBuilder count(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set
      Returns:
      Builder

    • total

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

    • results

      public ChannelPagedQueryResponseBuilder results(Channel... results)

      Channels matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • results

      public ChannelPagedQueryResponseBuilder results(List<Channel> results)

      Channels matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public ChannelPagedQueryResponseBuilder plusResults(Channel... results)

      Channels matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public ChannelPagedQueryResponseBuilder plusResults(Function<ChannelBuilder,ChannelBuilder> builder)

      Channels matching the query.

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

    • withResults

      public ChannelPagedQueryResponseBuilder withResults(Function<ChannelBuilder,ChannelBuilder> builder)

      Channels matching the query.

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

    • addResults

      public ChannelPagedQueryResponseBuilder addResults(Function<ChannelBuilder,Channel> builder)

      Channels matching the query.

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

    • setResults

      public ChannelPagedQueryResponseBuilder setResults(Function<ChannelBuilder,Channel> builder)

      Channels matching the query.

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

    • getLimit

      public Long getLimit()

      Number of results requested.

      Returns:
      limit

    • getOffset

      public Long getOffset()

      Number of elements skipped.

      Returns:
      offset

    • 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

    • getResults

      public List<Channel> getResults()

      Channels matching the query.

      Returns:
      results

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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