Struct google_firestore1_beta1::BatchGetDocumentsRequest [−][src]
pub struct BatchGetDocumentsRequest { pub new_transaction: Option<TransactionOptions>, pub transaction: Option<String>, pub mask: Option<DocumentMask>, pub documents: Option<Vec<String>>, pub read_time: Option<String>, }
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
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.
transaction: Option<String>
Reads documents in a transaction.
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.
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.
read_time: Option<String>
Reads documents as they were at the given time. This may not be older than 60 seconds.
Trait Implementations
impl Default for BatchGetDocumentsRequest
[src]
impl Default for BatchGetDocumentsRequest
fn default() -> BatchGetDocumentsRequest
[src]
fn default() -> BatchGetDocumentsRequest
Returns the "default value" for a type. Read more
impl Clone for BatchGetDocumentsRequest
[src]
impl Clone for BatchGetDocumentsRequest
fn clone(&self) -> BatchGetDocumentsRequest
[src]
fn clone(&self) -> BatchGetDocumentsRequest
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for BatchGetDocumentsRequest
[src]
impl Debug for BatchGetDocumentsRequest
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl RequestValue for BatchGetDocumentsRequest
[src]
impl RequestValue for BatchGetDocumentsRequest
Auto Trait Implementations
impl Send for BatchGetDocumentsRequest
impl Send for BatchGetDocumentsRequest
impl Sync for BatchGetDocumentsRequest
impl Sync for BatchGetDocumentsRequest