Struct google_firestore1_beta1::api::BatchGetDocumentsRequest

pub struct BatchGetDocumentsRequest {
    pub documents: Option<Vec<String>>,
    pub mask: Option<DocumentMask>,
    pub new_transaction: Option<TransactionOptions>,
    pub read_time: Option<String>,
    pub transaction: 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

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<String>

Reads documents as they were at the given time. This may not be older than 270 seconds.

transaction: Option<String>

Reads documents in a transaction.

Trait Implementations

impl Clone for BatchGetDocumentsRequest

fn clone(&self) -> BatchGetDocumentsRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchGetDocumentsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BatchGetDocumentsRequest

fn default() -> BatchGetDocumentsRequest

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for BatchGetDocumentsRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl RequestValue for BatchGetDocumentsRequest

impl Serialize for BatchGetDocumentsRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.