Struct IndexStatus 

#[non_exhaustive]
pub struct IndexStatus {
    pub index_time: Option<Timestamp>,
    pub error_samples: Vec<Status>,
    pub pending_message: String,
    /* private fields */
}

Available on crate features conversational-search-service or document-service or recommendation-service or search-service only.

Index status of the document.

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.

index_time: Option<Timestamp>

The time when the document was indexed. If this field is populated, it means the document has been indexed.

error_samples: Vec<Status>

A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.

pending_message: String

Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.

Implementations

impl IndexStatus

pub fn new() -> Self

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

where T: Into<Timestamp>,

Sets the value of index_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of index_time.

Example

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

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

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

Sets the value of error_samples.

Example

use rpc::model::Status;
let x = IndexStatus::new()
    .set_error_samples([
        Status::default()/* use setters */,
        Status::default()/* use (different) setters */,
    ]);

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

Sets the value of pending_message.

Example

let x = IndexStatus::new().set_pending_message("example");

Trait Implementations

impl Clone for IndexStatus

fn clone(&self) -> IndexStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexStatus

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

Formats the value using the given formatter.

impl Default for IndexStatus

fn default() -> IndexStatus

Returns the “default value” for a type.

impl Message for IndexStatus

fn typename() -> &'static str

The typename of this message.

impl PartialEq for IndexStatus

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