Skip to content

UpdateOptions

Options for Repository.update.

optional contextValues?: ContextValues

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

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


optional transaction?: Engine

Run the operation within a transaction.


optional updateMask?: FieldMask

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).


optional validateOnly?: boolean

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.

https://google.aip.dev/163