Struct Document 

#[non_exhaustive]
pub struct Document {
    pub name: String,
    pub id: String,
    pub schema_id: String,
    pub content: Option<Content>,
    pub parent_document_id: String,
    pub derived_struct_data: Option<Struct>,
    pub acl_info: Option<AclInfo>,
    pub index_time: Option<Timestamp>,
    pub index_status: Option<IndexStatus>,
    pub data: Option<Data>,
    /* private fields */
}

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

Document captures all raw metadata information of items to be recommended or searched.

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

Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

id: String

Immutable. The identifier of the document.

Id should conform to RFC-1034 standard with a length limit of 128 characters.

schema_id: String

The identifier of the schema located in the same data store.

content: Option<Content>

The unstructured data linked to this document. Content can only be set and must be set if this document is under a CONTENT_REQUIRED data store.

parent_document_id: String

The identifier of the parent document. Currently supports at most two level document hierarchy.

Id should conform to RFC-1034 standard with a length limit of 63 characters.

derived_struct_data: Option<Struct>

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

acl_info: Option<AclInfo>

Access control information for the document.

index_time: Option<Timestamp>

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

index_status: Option<IndexStatus>

Output only. The index status of the document.

• If document is indexed successfully, the index_time field is populated.
• Otherwise, if document is not indexed due to errors, the error_samples field is populated.
• Otherwise, if document’s index is in progress, the pending_message field is populated.

data: Option<Data>

Data representation. One of struct_data or json_data should be provided otherwise an INVALID_ARGUMENT error is thrown.

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}/locations/{location_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}"));

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

Sets the value of id.

Example

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

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

Sets the value of schema_id.

Example

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

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

where T: Into<Content>,

Sets the value of content.

Example

use google_cloud_discoveryengine_v1::model::document::Content;
let x = Document::new().set_content(Content::default()/* use setters */);

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

where T: Into<Content>,

Sets or clears the value of content.

Example

use google_cloud_discoveryengine_v1::model::document::Content;
let x = Document::new().set_or_clear_content(Some(Content::default()/* use setters */));
let x = Document::new().set_or_clear_content(None::<Content>);

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

Sets the value of parent_document_id.

Example

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

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

where T: Into<Struct>,

Sets the value of derived_struct_data.

Example

use wkt::Struct;
let x = Document::new().set_derived_struct_data(Struct::default()/* use setters */);

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

where T: Into<Struct>,

Sets or clears the value of derived_struct_data.

Example

use wkt::Struct;
let x = Document::new().set_or_clear_derived_struct_data(Some(Struct::default()/* use setters */));
let x = Document::new().set_or_clear_derived_struct_data(None::<Struct>);

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

where T: Into<AclInfo>,

Sets the value of acl_info.

Example

use google_cloud_discoveryengine_v1::model::document::AclInfo;
let x = Document::new().set_acl_info(AclInfo::default()/* use setters */);

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

where T: Into<AclInfo>,

Sets or clears the value of acl_info.

Example

use google_cloud_discoveryengine_v1::model::document::AclInfo;
let x = Document::new().set_or_clear_acl_info(Some(AclInfo::default()/* use setters */));
let x = Document::new().set_or_clear_acl_info(None::<AclInfo>);

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 = Document::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 = Document::new().set_or_clear_index_time(Some(Timestamp::default()/* use setters */));
let x = Document::new().set_or_clear_index_time(None::<Timestamp>);

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

where T: Into<IndexStatus>,

Sets the value of index_status.

Example

use google_cloud_discoveryengine_v1::model::document::IndexStatus;
let x = Document::new().set_index_status(IndexStatus::default()/* use setters */);

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

where T: Into<IndexStatus>,

Sets or clears the value of index_status.

Example

use google_cloud_discoveryengine_v1::model::document::IndexStatus;
let x = Document::new().set_or_clear_index_status(Some(IndexStatus::default()/* use setters */));
let x = Document::new().set_or_clear_index_status(None::<IndexStatus>);

pub fn set_data<T: Into<Option<Data>>>(self, v: T) -> Self

Sets the value of data.

Note that all the setters affecting data are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::document::Data;
let x = Document::new().set_data(Some(Data::JsonData("example".to_string())));

pub fn struct_data(&self) -> Option<&Box<Struct>>

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

pub fn set_struct_data<T: Into<Box<Struct>>>(self, v: T) -> Self

Sets the value of data to hold a StructData.

Note that all the setters affecting data are mutually exclusive.

Example

use wkt::Struct;
let x = Document::new().set_struct_data(Struct::default()/* use setters */);
assert!(x.struct_data().is_some());
assert!(x.json_data().is_none());

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

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

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

Sets the value of data to hold a JsonData.

Note that all the setters affecting data are mutually exclusive.

Example

let x = Document::new().set_json_data("example");
assert!(x.json_data().is_some());
assert!(x.struct_data().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