query-api/me.ahoo.wow.api.query/ListQuery

ListQuery

class ListQuery @InternalWowApi constructor(val filter: FilterExpression, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList(), val limit: Int? = null) : Queryable<ListQuery>

Data class representing a query for retrieving a list of items with optional filtering, projection, sorting, and limiting.

It supports all standard query operations (Queryable) and limits how many items it returns.

Constructors

ListQuery

@InternalWowApi

constructor(filter: FilterExpression, projection: Projection = Projection.ALL, sort: List<Sort> = emptyList(), limit: Int? = null)

Types

Companion

object Companion

Properties

filter

open override val filter: FilterExpression

The filter expression to apply to the query.

limit

val limit: Int?

The most items to return, at least 1; null, the default, takes the entry's default list size. Only trusted code that dropped the budget (trusted().unbounded()) lists every match with null; a stream (stream) reads every match in chunks.

projection

open override val projection: Projection

The field projection to control which fields are included in the results.

sort

open override val sort: List<Sort>

The sorting criteria to order the results.