public sealed class UpdateDocumentRequest : IMessage<UpdateDocumentRequest>, IEquatable<UpdateDocumentRequest>, IDeepCloneable<UpdateDocumentRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class UpdateDocumentRequest.
The request for
[Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].
The fields to update.
None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the
mask, they are left unchanged.
Fields referenced in the mask, but not present in the input document, are
deleted from the document on the server.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis page provides documentation for the \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class within the Google Cloud Firestore v1 API, with version 3.10.0 being the latest, and 3.6.0 being the version the current page is on.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class is used to request an update to a document in Firestore via the \u003ccode\u003eFirestore.UpdateDocument\u003c/code\u003e method, and includes parameters for setting preconditions, the document, mask, and updatemask.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements several interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e include \u003ccode\u003eCurrentDocument\u003c/code\u003e for preconditions, \u003ccode\u003eDocument\u003c/code\u003e for the document to be updated, \u003ccode\u003eMask\u003c/code\u003e for fields to return, and \u003ccode\u003eUpdateMask\u003c/code\u003e for specifying fields to update.\u003c/p\u003e\n"]]],[],null,[]]
