Struct ExportDocumentsRequest 

#[non_exhaustive]
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>,
    /* private fields */
}

The request for FirestoreAdmin.ExportDocuments.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

Implementations

impl ExportDocumentsRequest

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = ExportDocumentsRequest::new().set_name("example");

pub fn set_collection_ids<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of collection_ids.

Example

let x = ExportDocumentsRequest::new().set_collection_ids(["a", "b", "c"]);

pub fn set_output_uri_prefix<T: Into<String>>(self, v: T) -> Self

Sets the value of output_uri_prefix.

Example

let x = ExportDocumentsRequest::new().set_output_uri_prefix("example");

pub fn set_namespace_ids<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of namespace_ids.

Example

let x = ExportDocumentsRequest::new().set_namespace_ids(["a", "b", "c"]);

pub fn set_snapshot_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of snapshot_time.

Example

use wkt::Timestamp;
let x = ExportDocumentsRequest::new().set_snapshot_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_snapshot_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of snapshot_time.

Example

use wkt::Timestamp;
let x = ExportDocumentsRequest::new().set_or_clear_snapshot_time(Some(Timestamp::default()/* use setters */));
let x = ExportDocumentsRequest::new().set_or_clear_snapshot_time(None::<Timestamp>);

Trait Implementations

impl Clone for ExportDocumentsRequest

fn clone(&self) -> ExportDocumentsRequest

Returns a duplicate 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() -> ExportDocumentsRequest

Returns the “default value” for a type.

impl Message for ExportDocumentsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExportDocumentsRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ExportDocumentsRequest