Struct google_api_proto::google::firestore::admin::v1beta2::FieldOperationMetadata

pub struct FieldOperationMetadata {
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub field: String,
    pub index_config_deltas: Vec<IndexConfigDelta>,
    pub state: i32,
    pub document_progress: Option<Progress>,
    pub bytes_progress: Option<Progress>,
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField].

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.

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][google.firestore.admin.v1beta2.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.

state: i32

The state of the operation.

document_progress: Option<Progress>

The progress, in documents, of this operation.

bytes_progress: Option<Progress>

The progress, in bytes, of this operation.

Implementations

impl FieldOperationMetadata

pub fn state(&self) -> OperationState

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

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

Sets state to the provided enum value.

Trait Implementations

impl Clone for FieldOperationMetadata

fn clone(&self) -> FieldOperationMetadata

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for FieldOperationMetadata

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 FieldOperationMetadata

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