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 reference documentation for the \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class within the Google.Cloud.Firestore.V1 API, specifically for version 3.5.1 and other versions of the API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class is used to encapsulate a request for updating a document in Firestore, and it includes optional parameters for preconditions, document data, and update masks.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable<UpdateDocumentRequest>\u003c/code\u003e, \u003ccode\u003eIDeepCloneable<UpdateDocumentRequest>\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, providing functionality for message handling, equality comparisons, deep cloning, and buffered message operations.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUpdateDocumentRequest\u003c/code\u003e class contains properties like \u003ccode\u003eCurrentDocument\u003c/code\u003e, \u003ccode\u003eDocument\u003c/code\u003e, \u003ccode\u003eMask\u003c/code\u003e, and \u003ccode\u003eUpdateMask\u003c/code\u003e, which are used to specify preconditions, the updated document, fields to return, and fields to update respectively, in the Firestore document update request.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation outlines the different versions of the API with the latest being 3.10.0, allowing the user to choose the version they require.\u003c/p\u003e\n"]]],[],null,[]]
