pub struct BatchGetDocumentsRequest {
pub documents: Option<Vec<String>>,
pub mask: Option<DocumentMask>,
pub new_transaction: Option<TransactionOptions>,
pub read_time: Option<DateTime<Utc>>,
pub transaction: Option<Vec<u8>>,
}
Expand description
The request for Firestore.BatchGetDocuments.
§Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- databases documents batch get projects (request)
Fields§
§documents: Option<Vec<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.
mask: Option<DocumentMask>
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.
new_transaction: Option<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_time: Option<DateTime<Utc>>
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: Option<Vec<u8>>
Reads documents in a transaction.
Trait Implementations§
source§impl Clone for BatchGetDocumentsRequest
impl Clone for BatchGetDocumentsRequest
source§fn clone(&self) -> BatchGetDocumentsRequest
fn clone(&self) -> BatchGetDocumentsRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more