Struct gapi_grpc::google::firestore::admin::v1beta1::IndexOperationMetadata

pub struct IndexOperationMetadata {
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub index: String,
    pub operation_type: i32,
    pub cancelled: bool,
    pub document_progress: Option<Progress>,
}

Metadata for index operations. This metadata populates the metadata field of [google.longrunning.Operation][google.longrunning.Operation].

Fields

start_time: Option<Timestamp>

The time that work began on the operation.

end_time: Option<Timestamp>

The time the operation ended, either successfully or otherwise. Unset if the operation is still active.

index: String

The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/indexes/{index_id}

operation_type: i32

The type of index operation.

cancelled: bool

True if the [google.longrunning.Operation] was cancelled. If the cancellation is in progress, cancelled will be true but [google.longrunning.Operation.done][google.longrunning.Operation.done] will be false.

document_progress: Option<Progress>

Progress of the existing operation, measured in number of documents.

Implementations

impl IndexOperationMetadata

pub fn operation_type(&self) -> OperationType

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

pub fn set_operation_type(&mut self, value: OperationType)

Sets operation_type to the provided enum value.

Trait Implementations

impl Clone for IndexOperationMetadata

fn clone(&self) -> IndexOperationMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexOperationMetadata

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

Formats the value using the given formatter.

impl Default for IndexOperationMetadata

fn default() -> IndexOperationMetadata

Returns the “default value” for a type.

impl Message for IndexOperationMetadata

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<IndexOperationMetadata> for IndexOperationMetadata

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for IndexOperationMetadata