QueryFilter interface

用于定义在查询期间返回的一组扩展的筛选器。

属性

criteria

筛选器值定义此查询中的值集。 它们基于 QueryFilterType 应用。

direction

PagingDirection 将应用于分页令牌(如果存在)。 否则,将忽略方向,并使用从结果集开头开始的“向前”。 除非使用分页令牌来帮助防止将来出现问题,否则应将方向排除在请求之外。

pageNumber

用户请求的页码。 如果未提供,则默认假定为 1。

pageSize

页面大小定义调用方希望为此筛选器提供的结果数。 计数不能超过总体查询大小限制。

pagingToken

分页令牌是一种不同类型的筛选器,其他筛选器字段将被忽略。 分页令牌表示以前执行的查询的延续。 有关结果中的位置以及正在过滤的字段的信息嵌入在令牌中。

sortBy

定义要应用于结果的排序类型。 页面切片仅从排序结果中剪切。

sortOrder

定义排序顺序,1 表示升序,2 表示降序,否则默认排序基于 SortBy 值

属性详细信息

criteria

筛选器值定义此查询中的值集。 它们基于 QueryFilterType 应用。

criteria: FilterCriteria[]

属性值

direction

PagingDirection 将应用于分页令牌(如果存在)。 否则,将忽略方向,并使用从结果集开头开始的“向前”。 除非使用分页令牌来帮助防止将来出现问题,否则应将方向排除在请求之外。

direction: PagingDirection

属性值

pageNumber

用户请求的页码。 如果未提供,则默认假定为 1。

pageNumber: number

属性值

number

pageSize

页面大小定义调用方希望为此筛选器提供的结果数。 计数不能超过总体查询大小限制。

pageSize: number

属性值

number

pagingToken

分页令牌是一种不同类型的筛选器,其他筛选器字段将被忽略。 分页令牌表示以前执行的查询的延续。 有关结果中的位置以及正在过滤的字段的信息嵌入在令牌中。

pagingToken: string

属性值

string

sortBy

定义要应用于结果的排序类型。 页面切片仅从排序结果中剪切。

sortBy: number

属性值

number

sortOrder

定义排序顺序,1 表示升序,2 表示降序,否则默认排序基于 SortBy 值

sortOrder: number

属性值

number