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 page provides reference documentation for the `DocumentMask` class within the Firestore v1 API, specifically version 3.2.0."],["The `DocumentMask` class is used to define a subset of fields in a document for get or update operations, acting as a filter that restricts actions to only the specified fields."],["The latest version of the API documented is 3.10.0, with historical versions dating back to 2.3.0 also listed, giving the user a range of versions to refer to."],["`DocumentMask` inherits from `object` and implements several interfaces, such as `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, in addition to having two constructors."],["The `FieldPaths` property, a `RepeatedField` of strings, is the sole property shown for `DocumentMask`, and it dictates which fields will be subject to the restrictions of the mask."]]],[]]