Reference documentation and code samples for the Cloud Firestore V1 Client class DocumentsTarget.
A target specified by a set of documents names.
Generated from protobuf message google.firestore.v1.Target.DocumentsTarget
Namespace
Google \ Cloud \ Firestore \ V1 \ TargetMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ documents |
array
The names of the documents to retrieve. In the format: |
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 | |