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 document outlines the \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class within the Google Cloud Firestore v1 API, version 3.3.0, used for updating documents.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class implements multiple 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 updated document data, and both \u003ccode\u003eMask\u003c/code\u003e and \u003ccode\u003eUpdateMask\u003c/code\u003e for field management.\u003c/p\u003e\n"],["\u003cp\u003eThe class has two constructors, a default one and one that accepts another \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e object for initialization.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class is 3.10.0, and there are multiple other versions of the class that are accessible from the provided links.\u003c/p\u003e\n"]]],[],null,[]]