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\u003eThe latest version available for the \u003ccode\u003eDocumentMask\u003c/code\u003e class is 3.10.0, but the current page details version 3.8.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocumentMask\u003c/code\u003e is a class in the Firestore v1 API used to specify a subset of fields within a document for get or update operations.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\u003c/code\u003e class 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\u003eThe class includes a \u003ccode\u003eFieldPaths\u003c/code\u003e property, which is a \u003ccode\u003eRepeatedField\u003c/code\u003e of strings representing the list of field paths in the document mask.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocumentMask\u003c/code\u003e has two constructors, a default and another that takes a \u003ccode\u003eDocumentMask\u003c/code\u003e as a parameter for copying.\u003c/p\u003e\n"]]],[],null,[]]
