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 a
Document, and takes in account the dynamic nature of Value.
Generated from protobuf message google.firestore.v1beta1.DocumentMask
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. See Document.fields for a field path syntax reference.
getFieldPaths
The list of field paths in the mask. See Document.fields for a field
path syntax reference.
