Method: googleapis.firestore.v1.projects.databases.documents.batchGet

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Arguments

Parameters
database	string Required. The database name. In the format: projects/{project_id}/databases/{database_id}.
body	object (BatchGetDocumentsRequest) Required.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of BatchGetDocumentsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- batchGet:
    call: googleapis.firestore.v1.projects.databases.documents.batchGet
    args:
        database: ...
        body:
            documents: ...
            mask:
                fieldPaths: ...
            newTransaction:
                readOnly:
                    readTime: ...
                readWrite:
                    retryTransaction: ...
            readTime: ...
            transaction: ...
    result: batchGetResult

JSON

[
  {
    "batchGet": {
      "call": "googleapis.firestore.v1.projects.databases.documents.batchGet",
      "args": {
        "database": "...",
        "body": {
          "documents": "...",
          "mask": {
            "fieldPaths": "..."
          },
          "newTransaction": {
            "readOnly": {
              "readTime": "..."
            },
            "readWrite": {
              "retryTransaction": "..."
            }
          },
          "readTime": "...",
          "transaction": "..."
        }
      },
      "result": "batchGetResult"
    }
  }
]