GoogleApi.Firestore.V1beta1.Model.BatchGetDocumentsResponse (google_api_firestore v0.21.3) View Source

The streamed response for Firestore.BatchGetDocuments.


  • found (type: GoogleApi.Firestore.V1beta1.Model.Document.t, default: nil) - A document that was requested.
  • missing (type: String.t, default: nil) - A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.
  • readTime (type: DateTime.t, default: nil) - The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.
  • transaction (type: String.t, default: nil) - The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1beta1.Model.BatchGetDocumentsResponse{
  found: GoogleApi.Firestore.V1beta1.Model.Document.t() | nil,
  missing: String.t() | nil,
  readTime: DateTime.t() | nil,
  transaction: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.