BatchGetDocumentsRequest class

The request for Firestore.BatchGetDocuments.

Constructors

BatchGetDocumentsRequest()
BatchGetDocumentsRequest.fromJson(Map _json)

Properties

documents ↔ List<String>
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.
read / write
mask DocumentMask
The fields to return. If not set, returns all fields. [...]
read / write
newTransaction TransactionOptions
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.
read / write
readTime ↔ String
Reads documents as they were at the given time. This may not be older than 60 seconds.
read / write
transaction ↔ String
Reads documents in a transaction.
read / write
transactionAsBytes ↔ List<int>
read / write
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() → Map<String, Object>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited