BatchQueryApplicationObjectRecordReqBody.Builder (larksuite-oapi 2.4.14 API)

java.lang.Object
- com.lark.oapi.service.apaas.v1.model.BatchQueryApplicationObjectRecordReqBody.Builder

封闭类:: BatchQueryApplicationObjectRecordReqBody

public static class BatchQueryApplicationObjectRecordReqBody.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

构造器
构造器和说明
`Builder()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BatchQueryApplicationObjectRecordReqBody`	`build()`
`BatchQueryApplicationObjectRecordReqBody.Builder`	`filter(Criterion filter)` 筛选条件，通过 JSON 格式指定条件示例值：
`BatchQueryApplicationObjectRecordReqBody.Builder`	`groupBy(RecordGroupByItem[] groupBy)` 聚合参数，通过 JSON 格式指定条件。
`BatchQueryApplicationObjectRecordReqBody.Builder`	`needTotalCount(Boolean needTotalCount)` 是否返回符合条件的记录总数（Total）。
`BatchQueryApplicationObjectRecordReqBody.Builder`	`offset(Integer offset)` 返回记录的偏移量，默认为 0 ，即从查询到的第一条记录开始返回。
`BatchQueryApplicationObjectRecordReqBody.Builder`	`orderBy(Sort[] orderBy)` 排序参数，通过 JSON 格式指定条件。
`BatchQueryApplicationObjectRecordReqBody.Builder`	`pageSize(Integer pageSize)` 期望服务端返回的记录条数，上限 500 条。
`BatchQueryApplicationObjectRecordReqBody.Builder`	`pageToken(String pageToken)` 分页的 Token 值，由服务端生成，可从 Response 中的 next_page_token 参数中获取。
`BatchQueryApplicationObjectRecordReqBody.Builder`	`select(String[] select)` 需要获取的字段，使用字段唯一标识符进行查询，关联字段可使用「.」进行下钻示例值：
`BatchQueryApplicationObjectRecordReqBody.Builder`	`usePageToken(Boolean usePageToken)` 是否使用 page_token 功能。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - select
```
public BatchQueryApplicationObjectRecordReqBody.Builder select(String[] select)
```
    需要获取的字段，使用字段唯一标识符进行查询，关联字段可使用「.」进行下钻
    示例值：
    
    参数:
    
    select -
    
    返回:
  - filter
```
public BatchQueryApplicationObjectRecordReqBody.Builder filter(Criterion filter)
```
    筛选条件，通过 JSON 格式指定条件
    示例值：
    
    参数:
    
    filter -
    
    返回:
  - orderBy
```
public BatchQueryApplicationObjectRecordReqBody.Builder orderBy(Sort[] orderBy)
```
    排序参数，通过 JSON 格式指定条件。其中， field 为参与排序字段，direction 为排序方向，多个条件按其在数组中的顺序生效。
    示例值：
    
    参数:
    
    orderBy -
    
    返回:
  - groupBy
```
public BatchQueryApplicationObjectRecordReqBody.Builder groupBy(RecordGroupByItem[] groupBy)
```
    聚合参数，通过 JSON 格式指定条件。其中， field 为参与聚合的字段。
    示例值：
    
    参数:
    
    groupBy -
    
    返回:
  - pageToken
```
public BatchQueryApplicationObjectRecordReqBody.Builder pageToken(String pageToken)
```
    分页的 Token 值，由服务端生成，可从 Response 中的 next_page_token 参数中获取。注意：第一页需填写空字符串 ""，且不能与 OFFSET 一起使用。
    示例值：
    
    参数:
    
    pageToken -
    
    返回:
  - usePageToken
```
public BatchQueryApplicationObjectRecordReqBody.Builder usePageToken(Boolean usePageToken)
```
    是否使用 page_token 功能。为 True 时将使用 page_token 的值作为起始位置查询记录，并且会在 Response 中返回 next_page_token 。默认为 False 。
    示例值：false
    
    参数:
    
    usePageToken -
    
    返回:
  - pageSize
```
public BatchQueryApplicationObjectRecordReqBody.Builder pageSize(Integer pageSize)
```
    期望服务端返回的记录条数，上限 500 条。不填则取默认值，默认值为 500。
    示例值：100
    
    参数:
    
    pageSize -
    
    返回:
  - offset
```
public BatchQueryApplicationObjectRecordReqBody.Builder offset(Integer offset)
```
    返回记录的偏移量，默认为 0 ，即从查询到的第一条记录开始返回。offset 较大时查询性能较差，可能引起接口响应超时，拉取全部记录时建议使用 ID 游标分页，具体见 ID 游标分页说明
    示例值：0
    
    参数:
    
    offset -
    
    返回:
  - needTotalCount
```
public BatchQueryApplicationObjectRecordReqBody.Builder needTotalCount(Boolean needTotalCount)
```
    是否返回符合条件的记录总数（Total）。默认为 False，不返回记录总数。
    示例值：true
    
    参数:
    
    needTotalCount -
    
    返回:
  - build
```
public BatchQueryApplicationObjectRecordReqBody build()
```

类 BatchQueryApplicationObjectRecordReqBody.Builder

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Builder

方法详细资料

select

filter

orderBy

groupBy

pageToken

usePageToken

pageSize

offset

needTotalCount

build