public sealed class DocumentMask : IMessage<DocumentMask>, IEquatable<DocumentMask>, IDeepCloneable<DocumentMask>, IBufferMessage, IMessage
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 \u003ccode\u003eDocumentMask\u003c/code\u003e class represents a set of field paths on a document, used to restrict operations to a subset of fields.\u003c/p\u003e\n"],["\u003cp\u003eThis class, found in the \u003ccode\u003eGoogle.Cloud.Firestore.V1\u003c/code\u003e namespace, is different from standard field masks as it's specifically scoped to a \u003ccode\u003eDocument\u003c/code\u003e and considers the dynamic nature of \u003ccode\u003eValue\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt provides functionality through the \u003ccode\u003eFieldPaths\u003c/code\u003e property, which is a list of field paths, allowing users to specify which fields to include in operations.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements multiple interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, while inheriting from the \u003ccode\u003eObject\u003c/code\u003e class, supporting different operations.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version is 3.10.0 and there are many other versions all the way down to 2.3.0 that are accessible from this page.\u003c/p\u003e\n"]]],[],null,[]]
