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"]],[["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-06-12 UTC."],[[["This webpage provides reference documentation for the `DocumentMask` class within the Firestore v1 API, with versions ranging from 2.3.0 to 3.10.0, the latest version."],["`DocumentMask` is used to specify a subset of fields on a document for get or update operations, which differs from standard field masks by being scoped to a `Document` and accounting for the dynamic nature of `Value`."],["The `DocumentMask` class implements multiple interfaces, including `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, along with inheriting from the `object` class."],["The `DocumentMask` class has a `FieldPaths` property of type `RepeatedField\u003cstring\u003e`, which represents the list of field paths in the mask and uses the `Document.fields` syntax."],["The `DocumentMask` class includes two constructors, a default one and one that accepts another `DocumentMask` object as a parameter for copying."]]],[]]