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 \u003ccode\u003eDocumentMask\u003c/code\u003e class in the Firestore v1 API is used to specify a subset of fields for document operations like get or update, restricting the operation to only those listed fields.\u003c/p\u003e\n"],["\u003cp\u003eThis \u003ccode\u003eDocumentMask\u003c/code\u003e differs from standard field masks as it is specifically scoped to a Firestore \u003ccode\u003eDocument\u003c/code\u003e and considers the dynamic nature of the \u003ccode\u003eValue\u003c/code\u003e type.\u003c/p\u003e\n"],["\u003cp\u003eThe current documentation page provides reference details for multiple versions of the \u003ccode\u003eDocumentMask\u003c/code\u003e class, including version 3.10.0 as the latest and going back as far as 2.3.0, detailing how it inherits from base classes and implements multiple interfaces, such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\u003c/code\u003e class contains a property called \u003ccode\u003eFieldPaths\u003c/code\u003e, which is a \u003ccode\u003eRepeatedField<string>\u003c/code\u003e where each string is a field path referring to the \u003ccode\u003eDocument.fields\u003c/code\u003e for its syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe class contains 2 constructors one being a default \u003ccode\u003eDocumentMask()\u003c/code\u003e and \u003ccode\u003eDocumentMask(DocumentMask other)\u003c/code\u003e taking in a \u003ccode\u003eDocumentMask\u003c/code\u003e as its parameter.\u003c/p\u003e\n"]]],[],null,[]]
