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.
data
array
Optional. Data for populating the Message object.
↳ database
string
Required. The database name. In the format: projects/{project_id}/databases/{database_id}
.
↳ documents
array
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.
↳ 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}
.
string
setDatabase
Required. The database name. In the format: projects/{project_id}/databases/{database_id}
.
var
string
$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.
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.
var
string[]
$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.
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.
$this
getTransaction
Reads documents in a transaction.
string
hasTransaction
setTransaction
Reads documents in a transaction.
var
string
$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.
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.
$this
getReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
hasReadTime
setReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
$this
getConsistencySelector
string
