UpdateOptions
Defined in: packages/repo/src/types.ts:465
Options for Repository.update.
Properties
Section titled “Properties”contextValues?
Section titled “contextValues?”
optionalcontextValues?:ContextValues
Defined in: packages/repo/src/types.ts:495
Advanced: reuse an existing context bag for a nested repository call. When omitted, the repository creates a fresh bag for this operation.
readMask?
Section titled “readMask?”
optionalreadMask?:FieldMask
Defined in: packages/repo/src/types.ts:477
A FieldMask controlling which fields are returned.
Overrides the repository’s default read mask. Defaults to "*".
transaction?
Section titled “transaction?”
optionaltransaction?:Engine
Defined in: packages/repo/src/types.ts:489
Run the operation within a transaction.
updateMask?
Section titled “updateMask?”
optionalupdateMask?:FieldMask
Defined in: packages/repo/src/types.ts:471
A FieldMask controlling which fields from the input are
applied to the existing resource. Overrides the repository’s
default update mask. Defaults to "*" (all non-OUTPUT_ONLY fields).
validateOnly?
Section titled “validateOnly?”
optionalvalidateOnly?:boolean
Defined in: packages/repo/src/types.ts:486
If true, the resource is validated and merged but not persisted.
The returned message reflects what would have been updated
(including the recomputed etag), but no database write occurs.