public sealed class DocumentMask : IMessage<DocumentMask>, IEquatable<DocumentMask>, IDeepCloneable<DocumentMask>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class DocumentMask.
A set of field paths on a document.
Used to restrict a get or update operation on a document to a subset of its
fields.
This is different from standard field masks, as this is always scoped to a
[Document][google.firestore.v1.Document], and takes in account the dynamic
nature of [Value][google.firestore.v1.Value].
[[["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 webpage provides reference documentation for the \u003ccode\u003eDocumentMask\u003c/code\u003e class within the Firestore v1 API, with versions ranging from 2.3.0 to 3.10.0, the latest version.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocumentMask\u003c/code\u003e is used to specify a subset of fields on a document for get or update operations, which differs from standard field masks by being scoped to a \u003ccode\u003eDocument\u003c/code\u003e and accounting for the dynamic nature of \u003ccode\u003eValue\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\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, along with inheriting from the \u003ccode\u003eobject\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\u003c/code\u003e class has a \u003ccode\u003eFieldPaths\u003c/code\u003e property of type \u003ccode\u003eRepeatedField<string>\u003c/code\u003e, which represents the list of field paths in the mask and uses the \u003ccode\u003eDocument.fields\u003c/code\u003e syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\u003c/code\u003e class includes two constructors, a default one and one that accepts another \u003ccode\u003eDocumentMask\u003c/code\u003e object as a parameter for copying.\u003c/p\u003e\n"]]],[],null,[]]
