Struct DocumentMetadata 

#[non_exhaustive]
pub struct DocumentMetadata {
    pub matcher_value: Option<MatcherValue>,
    pub state: State,
    pub last_refreshed_time: Option<Timestamp>,
    pub data_ingestion_source: String,
    /* private fields */
}

Available on crate feature document-service only.

The metadata of a 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.

matcher_value: Option<MatcherValue>

The value of the matcher that was used to match the Document.

state: State

The state of the document.

last_refreshed_time: Option<Timestamp>

The timestamp of the last time the Document was last indexed.

data_ingestion_source: String

The data ingestion source of the Document.

Allowed values are:

• batch: Data ingested via Batch API, e.g., ImportDocuments.
• streaming Data ingested via Streaming API, e.g., FHIR streaming.

Implementations

impl DocumentMetadata

pub fn new() -> Self

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

where T: Into<MatcherValue>,

Sets the value of matcher_value.

Example

use google_cloud_discoveryengine_v1::model::batch_get_documents_metadata_response::document_metadata::MatcherValue;
let x = DocumentMetadata::new().set_matcher_value(MatcherValue::default()/* use setters */);

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

where T: Into<MatcherValue>,

Sets or clears the value of matcher_value.

Example

use google_cloud_discoveryengine_v1::model::batch_get_documents_metadata_response::document_metadata::MatcherValue;
let x = DocumentMetadata::new().set_or_clear_matcher_value(Some(MatcherValue::default()/* use setters */));
let x = DocumentMetadata::new().set_or_clear_matcher_value(None::<MatcherValue>);

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

Sets the value of state.

Example

use google_cloud_discoveryengine_v1::model::batch_get_documents_metadata_response::State;
let x0 = DocumentMetadata::new().set_state(State::Indexed);
let x1 = DocumentMetadata::new().set_state(State::NotInTargetSite);
let x2 = DocumentMetadata::new().set_state(State::NotInIndex);

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

where T: Into<Timestamp>,

Sets the value of last_refreshed_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of last_refreshed_time.

Example

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

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

Sets the value of data_ingestion_source.

Example

let x = DocumentMetadata::new().set_data_ingestion_source("example");

Trait Implementations

impl Clone for DocumentMetadata

fn clone(&self) -> DocumentMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMetadata

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

Formats the value using the given formatter.

impl Default for DocumentMetadata

fn default() -> DocumentMetadata

Returns the “default value” for a type.

impl Message for DocumentMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DocumentMetadata

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