Struct FieldOperationMetadata 

#[non_exhaustive]
pub struct FieldOperationMetadata {
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub field: String,
    pub index_config_deltas: Vec<IndexConfigDelta>,
    pub state: OperationState,
    pub progress_documents: Option<Progress>,
    pub progress_bytes: Option<Progress>,
    pub ttl_config_delta: Option<TtlConfigDelta>,
    /* private fields */
}

Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

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.

field: String

The field resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

index_config_deltas: Vec<IndexConfigDelta>

A list of IndexConfigDelta, which describe the intent of this operation.

state: OperationState

The state of the operation.

progress_documents: Option<Progress>

The progress, in documents, of this operation.

progress_bytes: Option<Progress>

The progress, in bytes, of this operation.

ttl_config_delta: Option<TtlConfigDelta>

Describes the deltas of TTL configuration.

Implementations

impl FieldOperationMetadata

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

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

Sets the value of field.

Example

let x = FieldOperationMetadata::new().set_field("example");

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

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

Sets the value of index_config_deltas.

Example

use google_cloud_firestore_admin_v1::model::field_operation_metadata::IndexConfigDelta;
let x = FieldOperationMetadata::new()
    .set_index_config_deltas([
        IndexConfigDelta::default()/* use setters */,
        IndexConfigDelta::default()/* use (different) setters */,
    ]);

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

Sets the value of state.

Example

use google_cloud_firestore_admin_v1::model::OperationState;
let x0 = FieldOperationMetadata::new().set_state(OperationState::Initializing);
let x1 = FieldOperationMetadata::new().set_state(OperationState::Processing);
let x2 = FieldOperationMetadata::new().set_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 = FieldOperationMetadata::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 = FieldOperationMetadata::new().set_or_clear_progress_documents(Some(Progress::default()/* use setters */));
let x = FieldOperationMetadata::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 = FieldOperationMetadata::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 = FieldOperationMetadata::new().set_or_clear_progress_bytes(Some(Progress::default()/* use setters */));
let x = FieldOperationMetadata::new().set_or_clear_progress_bytes(None::<Progress>);

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

where T: Into<TtlConfigDelta>,

Sets the value of ttl_config_delta.

Example

use google_cloud_firestore_admin_v1::model::field_operation_metadata::TtlConfigDelta;
let x = FieldOperationMetadata::new().set_ttl_config_delta(TtlConfigDelta::default()/* use setters */);

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

where T: Into<TtlConfigDelta>,

Sets or clears the value of ttl_config_delta.

Example

use google_cloud_firestore_admin_v1::model::field_operation_metadata::TtlConfigDelta;
let x = FieldOperationMetadata::new().set_or_clear_ttl_config_delta(Some(TtlConfigDelta::default()/* use setters */));
let x = FieldOperationMetadata::new().set_or_clear_ttl_config_delta(None::<TtlConfigDelta>);

Trait Implementations

impl Clone for FieldOperationMetadata

fn clone(&self) -> FieldOperationMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldOperationMetadata

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

Formats the value using the given formatter.

impl Default for FieldOperationMetadata

fn default() -> FieldOperationMetadata

Returns the “default value” for a type.

impl Message for FieldOperationMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FieldOperationMetadata

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