Struct google_api_proto::google::firestore::admin::v1::BulkDeleteDocumentsMetadata

pub struct BulkDeleteDocumentsMetadata {
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub operation_state: i32,
    pub progress_documents: Option<Progress>,
    pub progress_bytes: Option<Progress>,
    pub collection_ids: Vec<String>,
    pub namespace_ids: Vec<String>,
    pub snapshot_time: Option<Timestamp>,
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.BulkDeleteDocuments][google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments].

Fields

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: i32

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.

collection_ids: Vec<String>

The IDs of the collection groups that are being deleted.

namespace_ids: Vec<String>

Which namespace IDs are being deleted.

snapshot_time: Option<Timestamp>

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

Implementations

impl BulkDeleteDocumentsMetadata

pub fn operation_state(&self) -> OperationState

Returns the enum value of operation_state, or the default if the field is set to an invalid enum value.

pub fn set_operation_state(&mut self, value: OperationState)

Sets operation_state to the provided enum value.

Trait Implementations

impl Clone for BulkDeleteDocumentsMetadata

fn clone(&self) -> BulkDeleteDocumentsMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BulkDeleteDocumentsMetadata

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

Formats the value using the given formatter.

impl Default for BulkDeleteDocumentsMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for BulkDeleteDocumentsMetadata

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 BulkDeleteDocumentsMetadata

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