Reference documentation and code samples for the Cloud Firestore V1 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.v1.DocumentMask
Namespace
Google \ Cloud \ Firestore \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ field_paths
array
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-09 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class DocumentMask (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.DocumentMask)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.DocumentMask)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.DocumentMask)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.DocumentMask)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.DocumentMask)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.DocumentMask)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.DocumentMask)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.DocumentMask)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.DocumentMask)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.DocumentMask)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.DocumentMask)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.DocumentMask)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.DocumentMask)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.DocumentMask)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.DocumentMask)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.DocumentMask)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.DocumentMask)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.DocumentMask)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.DocumentMask)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.DocumentMask)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.DocumentMask)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.DocumentMask)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.DocumentMask) \nReference documentation and code samples for the Cloud Firestore V1 Client class DocumentMask.\n\nA set of field paths on a document.\n\nUsed to restrict a get or update operation on a document to a subset of its\nfields.\nThis is different from standard field masks, as this is always scoped to a\n[Document](/php/docs/reference/cloud-firestore/latest/V1.Document), and takes in account the dynamic\nnature of [Value](/php/docs/reference/cloud-firestore/latest/V1.Value).\n\nGenerated from protobuf message `google.firestore.v1.DocumentMask`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFieldPaths\n\nThe list of field paths in the mask. See\n[Document.fields](/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getFields__) for a field path\nsyntax reference.\n\n### setFieldPaths\n\nThe list of field paths in the mask. See\n[Document.fields](/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getFields__) for a field path\nsyntax reference."]]
