Struct ExportDocumentsMetadata 

#[non_exhaustive]
pub struct ExportDocumentsMetadata {
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub operation_state: OperationState,
    pub progress_documents: Option<Progress>,
    pub progress_bytes: Option<Progress>,
    pub collection_ids: Vec<String>,
    pub output_uri_prefix: String,
    pub namespace_ids: Vec<String>,
    pub snapshot_time: Option<Timestamp>,
    /* private fields */
}

Metadata for google.longrunning.Operation results from 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.

start_time: Option<Timestamp>

The time this operation started.

end_time: Option<Timestamp>

The time this operation completed. Will be unset if operation still in progress.

operation_state: OperationState

The state of the export operation.

progress_documents: Option<Progress>

The progress, in documents, of this operation.

progress_bytes: Option<Progress>

The progress, in bytes, of this operation.

collection_ids: Vec<String>

Which collection IDs are being exported.

output_uri_prefix: String

Where the documents are being exported to.

namespace_ids: Vec<String>

Which namespace IDs are being exported.

snapshot_time: Option<Timestamp>

The timestamp that corresponds to the version of the database that is being exported. If unspecified, there are no guarantees about the consistency of the documents being exported.

Implementations

impl ExportDocumentsMetadata

pub fn new() -> Self

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of end_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

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

pub fn set_operation_state<T: Into<OperationState>>(self, v: T) -> Self

Sets the value of operation_state.

Example

use google_cloud_firestore_admin_v1::model::OperationState;
let x0 = ExportDocumentsMetadata::new().set_operation_state(OperationState::Initializing);
let x1 = ExportDocumentsMetadata::new().set_operation_state(OperationState::Processing);
let x2 = ExportDocumentsMetadata::new().set_operation_state(OperationState::Cancelling);

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

where T: Into<Progress>,

Sets the value of progress_documents.

Example

use google_cloud_firestore_admin_v1::model::Progress;
let x = ExportDocumentsMetadata::new().set_progress_documents(Progress::default()/* use setters */);

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

where T: Into<Progress>,

Sets or clears the value of progress_documents.

Example

use google_cloud_firestore_admin_v1::model::Progress;
let x = ExportDocumentsMetadata::new().set_or_clear_progress_documents(Some(Progress::default()/* use setters */));
let x = ExportDocumentsMetadata::new().set_or_clear_progress_documents(None::<Progress>);

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

where T: Into<Progress>,

Sets the value of progress_bytes.

Example

use google_cloud_firestore_admin_v1::model::Progress;
let x = ExportDocumentsMetadata::new().set_progress_bytes(Progress::default()/* use setters */);

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

where T: Into<Progress>,

Sets or clears the value of progress_bytes.

Example

use google_cloud_firestore_admin_v1::model::Progress;
let x = ExportDocumentsMetadata::new().set_or_clear_progress_bytes(Some(Progress::default()/* use setters */));
let x = ExportDocumentsMetadata::new().set_or_clear_progress_bytes(None::<Progress>);

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 = ExportDocumentsMetadata::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 = ExportDocumentsMetadata::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 = ExportDocumentsMetadata::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 = ExportDocumentsMetadata::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 = ExportDocumentsMetadata::new().set_or_clear_snapshot_time(Some(Timestamp::default()/* use setters */));
let x = ExportDocumentsMetadata::new().set_or_clear_snapshot_time(None::<Timestamp>);

Trait Implementations

impl Clone for ExportDocumentsMetadata

fn clone(&self) -> ExportDocumentsMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExportDocumentsMetadata

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

Formats the value using the given formatter.

impl Default for ExportDocumentsMetadata

fn default() -> ExportDocumentsMetadata

Returns the “default value” for a type.

impl Message for ExportDocumentsMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExportDocumentsMetadata

fn eq(&self, other: &ExportDocumentsMetadata) -> 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 ExportDocumentsMetadata