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."],[[["This webpage provides documentation for the `DocumentMask` class within the Google Cloud Firestore v1 API, focusing on version 3.4.0 and offering access to other versions."],["`DocumentMask` is used to specify a subset of fields within a document for operations like get or update, differing from standard field masks due to its scope within a `Document`."],["The `DocumentMask` class implements several interfaces, including `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, demonstrating its capabilities within the Protobuf framework."],["The class includes constructors for creating new `DocumentMask` instances, either empty or based on another `DocumentMask` instance, allowing flexibility in creation."],["The `FieldPaths` property, which is of type `RepeatedField\u003cstring\u003e`, allows users to define and access the specific field paths that are part of the document mask."]]],[]]
