View Source GoogleApi.Firestore.V1.Model.BatchGetDocumentsRequest (google_api_firestore v0.26.0)
The request for Firestore.BatchGetDocuments.
Attributes
-
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 givendatabase
. 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 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. -
transaction
(type:String.t
, default:nil
) - Reads documents in a transaction.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type 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 }
Functions
Unwrap a decoded JSON object into its complex fields.