Struct Document 

#[non_exhaustive]
pub struct Document {
    pub name: String,
    pub display_name: String,
    pub mime_type: String,
    pub knowledge_types: Vec<KnowledgeType>,
    pub enable_auto_reload: bool,
    pub latest_reload_status: Option<ReloadStatus>,
    pub metadata: HashMap<String, String>,
    pub state: State,
    pub source: Option<Source>,
    /* private fields */
}

Available on crate feature documents only.

A knowledge document to be used by a KnowledgeBase.

For more information, see the knowledge base guide.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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.

name: String

Optional. The document resource name. The name must be empty when creating a document. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

display_name: String

Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.

mime_type: String

Required. The MIME type of this document.

knowledge_types: Vec<KnowledgeType>

Required. The knowledge type of document content.

enable_auto_reload: bool

Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don’t try to automatically reload the document.

Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types.

Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged.

If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.

latest_reload_status: Option<ReloadStatus>

Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

metadata: HashMap<String, String>

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document’s title, an external URL distinct from the document’s content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.

state: State

Output only. The current state of the document.

source: Option<Source>

Required. The source of this document.

Implementations

impl Document

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Document::new().set_name(format!("projects/{project_id}/knowledgeBases/{knowledge_base_id}/documents/{document_id}"));

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

Sets the value of display_name.

Example

let x = Document::new().set_display_name("example");

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

Sets the value of mime_type.

Example

let x = Document::new().set_mime_type("example");

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

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

Sets the value of knowledge_types.

Example

use google_cloud_dialogflow_v2::model::document::KnowledgeType;
let x = Document::new().set_knowledge_types([
    KnowledgeType::Faq,
    KnowledgeType::ExtractiveQa,
    KnowledgeType::ArticleSuggestion,
]);

pub fn set_enable_auto_reload<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_auto_reload.

Example

let x = Document::new().set_enable_auto_reload(true);

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

where T: Into<ReloadStatus>,

Sets the value of latest_reload_status.

Example

use google_cloud_dialogflow_v2::model::document::ReloadStatus;
let x = Document::new().set_latest_reload_status(ReloadStatus::default()/* use setters */);

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

where T: Into<ReloadStatus>,

Sets or clears the value of latest_reload_status.

Example

use google_cloud_dialogflow_v2::model::document::ReloadStatus;
let x = Document::new().set_or_clear_latest_reload_status(Some(ReloadStatus::default()/* use setters */));
let x = Document::new().set_or_clear_latest_reload_status(None::<ReloadStatus>);

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of metadata.

Example

let x = Document::new().set_metadata([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

Sets the value of state.

Example

use google_cloud_dialogflow_v2::model::document::State;
let x0 = Document::new().set_state(State::Creating);
let x1 = Document::new().set_state(State::Active);
let x2 = Document::new().set_state(State::Updating);

pub fn set_source<T: Into<Option<Source>>>(self, v: T) -> Self

Sets the value of source.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::document::Source;
let x = Document::new().set_source(Some(Source::ContentUri("example".to_string())));

pub fn content_uri(&self) -> Option<&String>

The value of source if it holds a ContentUri, None if the field is not set or holds a different branch.

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

Sets the value of source to hold a ContentUri.

Note that all the setters affecting source are mutually exclusive.

Example

let x = Document::new().set_content_uri("example");
assert!(x.content_uri().is_some());
assert!(x.raw_content().is_none());

pub fn raw_content(&self) -> Option<&Bytes>

The value of source if it holds a RawContent, None if the field is not set or holds a different branch.

pub fn set_raw_content<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of source to hold a RawContent.

Note that all the setters affecting source are mutually exclusive.

Example

let x = Document::new().set_raw_content(bytes::Bytes::from_static(b"example"));
assert!(x.raw_content().is_some());
assert!(x.content_uri().is_none());

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl Message for Document

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document