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-03-21 UTC."],[[["The `DocumentMask` 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."],["This `DocumentMask` differs from standard field masks as it is specifically scoped to a Firestore `Document` and considers the dynamic nature of the `Value` type."],["The current documentation page provides reference details for multiple versions of the `DocumentMask` 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 `IMessage`, `IEquatable`, `IDeepCloneable`, `IBufferMessage`."],["The `DocumentMask` class contains a property called `FieldPaths`, which is a `RepeatedField\u003cstring\u003e` where each string is a field path referring to the `Document.fields` for its syntax."],["The class contains 2 constructors one being a default `DocumentMask()` and `DocumentMask(DocumentMask other)` taking in a `DocumentMask` as its parameter."]]],[]]
