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\u003eThis webpage details the \u003ccode\u003eDocumentMask\u003c/code\u003e class within the \u003ccode\u003eGoogle.Cloud.Firestore.V1\u003c/code\u003e namespace, which is used to define a subset of fields for document operations.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\u003c/code\u003e class, which inherits from \u003ccode\u003eObject\u003c/code\u003e, implements interfaces like \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 latest available version of this API is 3.10.0, but the page specifically focuses on version 2.3.0, with numerous other versions also documented, allowing users to access relevant data for their particular requirements.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocumentMask\u003c/code\u003e includes a \u003ccode\u003eFieldPaths\u003c/code\u003e property, which is a list of field paths used to restrict operations to specific fields within a document, formatted as a \u003ccode\u003eRepeatedField\u003c/code\u003e of strings.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentMask\u003c/code\u003e class is constructed either as an empty object or as a copy of an existing \u003ccode\u003eDocumentMask\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,[]]
