Struct Document 

#[non_exhaustive]
pub struct Document {
    pub name: String,
    pub uri: String,
    pub content: String,
    pub description: String,
    pub data_source: String,
    pub title: String,
    pub update_time: Option<Timestamp>,
    pub view: DocumentView,
    pub content_length_bytes: i32,
    /* private fields */
}

A Document represents a page of documentation in the Developer Knowledge corpus, like the page at https://docs.cloud.google.com/storage/docs/creating-buckets.

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

Identifier. Contains the resource name of the document. Format: documents/{uri_without_scheme} Example: documents/docs.cloud.google.com/storage/docs/creating-buckets

uri: String

Output only. Provides the URI of the content, such as docs.cloud.google.com/storage/docs/creating-buckets.

content: String

Output only. Contains the full content of the document in Markdown format.

description: String

Output only. Provides a description of the document.

data_source: String

Output only. Specifies the data source of the document. Example data source: firebase.google.com

title: String

Output only. Provides the title of the document.

update_time: Option<Timestamp>

Output only. Represents the timestamp when the content or metadata of the document was last updated.

view: DocumentView

Output only. Specifies the DocumentView of the document.

content_length_bytes: i32

Output only. The length of the content field in bytes.

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!("documents/{document_id}"));

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

Sets the value of uri.

Example

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

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

Sets the value of content.

Example

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

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

Sets the value of description.

Example

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

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

Sets the value of data_source.

Example

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

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

Sets the value of title.

Example

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

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

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

pub fn set_view<T: Into<DocumentView>>(self, v: T) -> Self

Sets the value of view.

Example

use google_developers_knowledge_v1::model::DocumentView;
let x0 = Document::new().set_view(DocumentView::Basic);
let x1 = Document::new().set_view(DocumentView::Full);
let x2 = Document::new().set_view(DocumentView::Content);

pub fn set_content_length_bytes<T: Into<i32>>(self, v: T) -> Self

Sets the value of content_length_bytes.

Example

let x = Document::new().set_content_length_bytes(42);

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