Cloud Firestore V1beta1 Client - Class DocumentsTarget (1.31.0)

Version 1.31.0

• 1.47.2 (latest)
• 1.47.1
• 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 DocumentsTarget.

A target specified by a set of documents names.

Generated from protobuf message google.firestore.v1beta1.Target.DocumentsTarget

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ documents	string[] The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

getDocuments

The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDocuments

The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this