ListOptions

Defined in: types.ts:328

Properties

orderBy?

optional orderBy?: string

Defined in: types.ts:346

An AIP-132 order_by string (e.g. "age desc, display_name"). Fields are validated against the proto schema.

---

pageSize?

optional pageSize?: number

Defined in: types.ts:333

Maximum number of results to return per page. Clamped to the repository’s maxSize. Defaults to defaultSize.

---

pageToken?

optional pageToken?: PageToken

Defined in: types.ts:340

A PageToken for offset-based pagination. Obtain this by calling parse() from @protoutil/aip/pagination on the raw page token string from the client request.

---

readMask?

optional readMask?: FieldMask

Defined in: types.ts:358

A FieldMask controlling which fields are returned. Overrides the repository’s default read mask. Defaults to "*".

---

showTotalSize?

optional showTotalSize?: boolean

Defined in: types.ts:352

When true, the result includes a totalSize field with the total number of matching resources (before pagination).

---

transaction?

optional transaction?: Engine

Defined in: types.ts:361

Run the operation within a transaction.