GoogleApi.Firestore.V1.Model.BatchGetDocumentsRequest (google_api_firestore v0.21.3) View Source

The request for Firestore.BatchGetDocuments.


  • documents (type: list(String.t), default: nil) - 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 (type: GoogleApi.Firestore.V1.Model.DocumentMask.t, default: nil) - 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.
  • newTransaction (type: GoogleApi.Firestore.V1.Model.TransactionOptions.t, default: nil) - 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.
  • readTime (type: DateTime.t, default: nil) - Reads documents as they were at the given time. This may not be older than 270 seconds.
  • transaction (type: String.t, default: nil) - Reads documents in a transaction.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1.Model.BatchGetDocumentsRequest{
  documents: [String.t()] | nil,
  mask: GoogleApi.Firestore.V1.Model.DocumentMask.t() | nil,
  newTransaction: GoogleApi.Firestore.V1.Model.TransactionOptions.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.