Cloud Firestore V1beta1 Client - Class DocumentMask (1.27.3)

Version 1.27.3

• 1.47.3 (latest)
• 1.47.2
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setFieldPaths

The list of field paths in the mask. See Document.fields for a field path syntax reference.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this