Reference documentation and code samples for the Cloud Firestore V1 Client class BatchGetDocumentsRequest.
The request for Firestore.BatchGetDocuments.
Generated from protobuf message google.firestore.v1.BatchGetDocumentsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ database |
string
Required. The database name. In the format: |
↳ documents |
array
The names of the documents to retrieve. In the format: |
↳ mask |
Google\Cloud\Firestore\V1\DocumentMask
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. |
↳ transaction |
string
Reads documents in a transaction. |
↳ new_transaction |
Google\Cloud\Firestore\V1\TransactionOptions
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. |
↳ read_time |
Google\Protobuf\Timestamp
Reads documents as they were at the given time. This may not be older than 270 seconds. |
getDatabase
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setDatabase
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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 | |
getMask
The fields to return. If not set, returns all fields.
If a document has a field that is not present in this mask, that field will not be returned in the response.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\DocumentMask|null | |
hasMask
clearMask
setMask
The fields to return. If not set, returns all fields.
If a document has a field that is not present in this mask, that field will not be returned in the response.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\DocumentMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTransaction
Reads documents in a transaction.
| Returns | |
|---|---|
| Type | Description |
string | |
hasTransaction
setTransaction
Reads documents in a transaction.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNewTransaction
Starts a new transaction and reads the documents.
Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\TransactionOptions|null | |
hasNewTransaction
setNewTransaction
Starts a new transaction and reads the documents.
Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\TransactionOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasReadTime
setReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConsistencySelector
| Returns | |
|---|---|
| Type | Description |
string | |