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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[[["This webpage details the `DocumentMask` class within the `Google.Cloud.Firestore.V1` namespace, which is used to define a subset of fields for document operations."],["The `DocumentMask` class, which inherits from `Object` and implements multiple interfaces, including `IMessage`, `IEquatable`, and `IDeepCloneable`, is used to specify which fields should be included in operations like get or update."],["The class is part of the `Google.Cloud.Firestore.V1.dll` assembly and includes constructors for creating new instances and copying existing ones."],["The `DocumentMask` class contains a `FieldPaths` property of type `RepeatedField\u003cstring\u003e` which allows you to see the list of field paths in the mask for a document."],["This page contains the documentation for the `DocumentMask` class starting from version `2.3.0`, and up to the latest version `3.10.0`."]]],[]]