ListOptions
Options for Repository.list.
Properties
Section titled “Properties”contextValues?
Section titled “contextValues?”
optionalcontextValues?:ContextValues
Advanced: reuse an existing context bag for a nested repository call. When omitted, the repository creates a fresh bag for this operation.
orderBy?
Section titled “orderBy?”
optionalorderBy?:string
An AIP-132 order_by string (e.g. "age desc, display_name").
Fields are validated against the proto schema.
pageSize?
Section titled “pageSize?”
optionalpageSize?:number
Maximum number of results to return per page. Clamped to the
repository’s maxSize. Defaults to defaultSize.
pageToken?
Section titled “pageToken?”
optionalpageToken?:PageToken
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?
Section titled “readMask?”
optionalreadMask?:FieldMask
A FieldMask controlling which fields are returned.
Overrides the repository’s default read mask. Defaults to "*".
showTotalSize?
Section titled “showTotalSize?”
optionalshowTotalSize?:boolean
When true, the result includes a totalSize field with the
total number of matching resources (before pagination).
transaction?
Section titled “transaction?”
optionaltransaction?:Engine
Run the operation within a transaction.