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-05 UTC."],[[["The `DocumentMask` class in the Firestore v1 API is used to specify a subset of fields in a document for get or update operations."],["This class implements several interfaces including `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`."],["The `DocumentMask` is distinct from standard field masks because it is specifically tailored to `Document` objects and the dynamic nature of `Value`."],["The latest version available for `DocumentMask` is 3.10.0, with several previous versions listed, down to version 2.3.0."],["`DocumentMask` has a `FieldPaths` property, which is a list of strings that specifies which fields are included in the mask, referencing the `Document.fields` syntax for path specification."]]],[]]
