Skip to content

BatchUpdateOptions

Defined in: packages/repo/src/types.ts:615

Options for Repository.batchUpdate.

optional contextValues?: ContextValues

Defined in: packages/repo/src/types.ts:643

Advanced: reuse an existing context bag for a nested repository call. When omitted, the repository creates a fresh bag for this operation.


optional readMask?: FieldMask

Defined in: packages/repo/src/types.ts:620

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


optional transaction?: Engine

Defined in: packages/repo/src/types.ts:637

Run the operation within a transaction. When provided, the batch operation participates in the caller’s transaction rather than opening a new one. The caller is responsible for committing or rolling back.


optional validateOnly?: boolean

Defined in: packages/repo/src/types.ts:629

If true, all resources are validated and merged but not persisted. The returned messages reflect what would have been updated (including recomputed etags), but no database writes occur.

https://google.aip.dev/163