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

Gets a single document.

Every document in Cloud Firestore is uniquely identified by its location within the database. Documents live in collections and the names of documents within a collection are unique. Note that {document_path} refers to the fully specified document path and includes the collection ID. For more information, see Cloud Firestore data model and the Cloud Firestore connector sample.

Arguments

Parameters
`name`	`string` Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
`mask.fieldPaths`	`string` The list of field paths in the mask. See Document.fields for a field path syntax reference.
`readTime`	`string (Timestamp format)` Reads the version of the document at the given time. This may not be older than 270 seconds.
`transaction`	`string (bytes format)` Reads the document in a transaction.

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 Document.

Subworkflow snippet

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

YAML

- get:
    call: googleapis.firestore.v1.projects.databases.documents.get
    args:
        name: ...
        mask:
            fieldPaths: ...
        readTime: ...
        transaction: ...
    result: getResult

JSON

[
  {
    "get": {
      "call": "googleapis.firestore.v1.projects.databases.documents.get",
      "args": {
        "name": "...",
        "mask": {
          "fieldPaths": "..."
        },
        "readTime": "...",
        "transaction": "..."
      },
      "result": "getResult"
    }
  }
]