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 page provides reference documentation for the \u003ccode\u003eDocumentMask\u003c/code\u003e class within the Firestore v1 API, specifically version 3.2.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\u003c/code\u003e class is used to define a subset of fields in a document for get or update operations, acting as a filter that restricts actions to only the specified fields.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the API documented is 3.10.0, with historical versions dating back to 2.3.0 also listed, giving the user a range of versions to refer to.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocumentMask\u003c/code\u003e inherits from \u003ccode\u003eobject\u003c/code\u003e and implements several interfaces, such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, in addition to having two constructors.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFieldPaths\u003c/code\u003e property, a \u003ccode\u003eRepeatedField\u003c/code\u003e of strings, is the sole property shown for \u003ccode\u003eDocumentMask\u003c/code\u003e, and it dictates which fields will be subject to the restrictions of the mask.\u003c/p\u003e\n"]]],[],null,[]]
