Package com.commercetools.api.models.variant

Interface VariantProjectionPagedQueryResponse

public interface VariantProjectionPagedQueryResponse
VariantProjectionPagedQueryResponse
Example to create an instance using the builder pattern 

     VariantProjectionPagedQueryResponse variantProjectionPagedQueryResponse = VariantProjectionPagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Method Details

    • getLimit

      @NotNull @NotNull Long getLimit()

      Number of results requested.

      Returns:
      limit

    • getCount

      @NotNull @NotNull Long getCount()

      Actual number of results returned.

      Returns:
      count

    • getTotal

      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

      @NotNull @NotNull Long getOffset()

      Number of elements skipped.

      Returns:
      offset

    • getResults

      @NotNull @Valid @NotNull @Valid List<VariantProjection> getResults()

      VariantProjections matching the query.

      Returns:
      results

    • setLimit

      void setLimit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set

    • setCount

      void setCount(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set

    • setTotal

      void setTotal(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

    • setOffset

      void setOffset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set

    • setResults

      void setResults(VariantProjection... results)

      VariantProjections matching the query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<VariantProjection> results)

      VariantProjections matching the query.

      Parameters:
      results - values to be set

    • of

      static VariantProjectionPagedQueryResponse of()
      factory method
      Returns:
      instance of VariantProjectionPagedQueryResponse

    • of

      static VariantProjectionPagedQueryResponse of(VariantProjectionPagedQueryResponse template)
      factory method to create a shallow copy VariantProjectionPagedQueryResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      VariantProjectionPagedQueryResponse copyDeep()

    • deepCopy

      @Nullable static VariantProjectionPagedQueryResponse deepCopy(@Nullable VariantProjectionPagedQueryResponse template)
      factory method to create a deep copy of VariantProjectionPagedQueryResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static VariantProjectionPagedQueryResponseBuilder builder()
      builder factory method for VariantProjectionPagedQueryResponse
      Returns:
      builder

    • builder

      static VariantProjectionPagedQueryResponseBuilder builder(VariantProjectionPagedQueryResponse template)
      create builder for VariantProjectionPagedQueryResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withVariantProjectionPagedQueryResponse

      default <T> T withVariantProjectionPagedQueryResponse(Function<VariantProjectionPagedQueryResponse,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<VariantProjectionPagedQueryResponse> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference