Struct google_api_proto::google::firestore::admin::v1::ExportDocumentsRequest

pub struct ExportDocumentsRequest {
    pub name: String,
    pub collection_ids: Vec<String>,
    pub output_uri_prefix: String,
    pub namespace_ids: Vec<String>,
    pub snapshot_time: Option<Timestamp>,
}

The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

Fields

name: String

Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}.

collection_ids: Vec<String>

Which collection ids to export. Unspecified means all collections. Each collection id in this list must be unique.

output_uri_prefix: String

The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME\[/NAMESPACE_PATH\], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

namespace_ids: Vec<String>

An empty list represents all namespaces. This is the preferred usage for databases that don’t use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn’t want to include them. Each namespace in this list must be unique.

snapshot_time: Option<Timestamp>

The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than [earliestVersionTime][google.firestore.admin.v1.Database.earliest_version_time]. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.

Trait Implementations

impl Clone for ExportDocumentsRequest

fn clone(&self) -> ExportDocumentsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExportDocumentsRequest

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

Formats the value using the given formatter.

impl Default for ExportDocumentsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ExportDocumentsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ExportDocumentsRequest

fn eq(&self, other: &ExportDocumentsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExportDocumentsRequest