Reference documentation and code samples for the Cloud Firestore V1 Client class BatchGetDocumentsRequest.
The request forFirestore.BatchGetDocuments.
Generated from protobuf messagegoogle.firestore.v1.BatchGetDocumentsRequest
Namespace
Google \ Cloud \ Firestore \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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 givendatabase. Duplicate names will be elided.
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.
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.
Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
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
givendatabase. Duplicate names will be elided.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class BatchGetDocumentsRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.BatchGetDocumentsRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.BatchGetDocumentsRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.BatchGetDocumentsRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.BatchGetDocumentsRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.BatchGetDocumentsRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.BatchGetDocumentsRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.BatchGetDocumentsRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.BatchGetDocumentsRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.BatchGetDocumentsRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.BatchGetDocumentsRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.BatchGetDocumentsRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.BatchGetDocumentsRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.BatchGetDocumentsRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.BatchGetDocumentsRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.BatchGetDocumentsRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.BatchGetDocumentsRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.BatchGetDocumentsRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.BatchGetDocumentsRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.BatchGetDocumentsRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.BatchGetDocumentsRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.BatchGetDocumentsRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.BatchGetDocumentsRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.BatchGetDocumentsRequest) \nReference documentation and code samples for the Cloud Firestore V1 Client class BatchGetDocumentsRequest.\n\nThe request for\nFirestore.BatchGetDocuments.\n\nGenerated from protobuf message `google.firestore.v1.BatchGetDocumentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDatabase\n\nRequired. The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\n\n### setDatabase\n\nRequired. The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\n\n### getDocuments\n\nThe names of the documents to retrieve. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\nThe request will fail if any of the document is not a child resource of the\ngiven `database`. Duplicate names will be elided.\n\n### setDocuments\n\nThe names of the documents to retrieve. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\nThe request will fail if any of the document is not a child resource of the\ngiven `database`. Duplicate names will be elided.\n\n### getMask\n\nThe fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response.\n\n### hasMask\n\n### clearMask\n\n### setMask\n\nThe fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response.\n\n### getTransaction\n\nReads documents in a transaction.\n\n### hasTransaction\n\n### setTransaction\n\nReads documents in a transaction.\n\n### getNewTransaction\n\nStarts a new transaction and reads the documents.\n\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream.\n\n### hasNewTransaction\n\n### setNewTransaction\n\nStarts a new transaction and reads the documents.\n\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream.\n\n### getReadTime\n\nReads documents as they were at the given time.\n\nThis must be a microsecond precision timestamp within the past one hour,\nor if Point-in-Time Recovery is enabled, can additionally be a whole\nminute timestamp within the past 7 days.\n\n### hasReadTime\n\n### setReadTime\n\nReads documents as they were at the given time.\n\nThis must be a microsecond precision timestamp within the past one hour,\nor if Point-in-Time Recovery is enabled, can additionally be a whole\nminute timestamp within the past 7 days.\n\n### getConsistencySelector"]]
