Reference documentation and code samples for the Cloud Firestore V1beta1 Client 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 aDocument, and takes in account the dynamic nature ofValue.
Generated from protobuf messagegoogle.firestore.v1beta1.DocumentMask
Namespace
Google \ Cloud \ Firestore \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ field_paths
string[]
The list of field paths in the mask. SeeDocument.fieldsfor a field path syntax reference.
getFieldPaths
The list of field paths in the mask. SeeDocument.fieldsfor a field
path syntax reference.
[[["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-09-04 UTC."],[],[],null,[]]
