Struct Example 

#[non_exhaustive]
pub struct Example {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub entry_agent: String,
    pub messages: Vec<Message>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub invalid: bool,
    pub etag: String,
    /* private fields */
}

An example represents a sample conversation between the user and the agent(s).

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. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}

display_name: String

Required. Display name of the example.

description: String

Optional. Human-readable description of the example.

entry_agent: String

Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

messages: Vec<Message>

Optional. The collection of messages that make up the conversation.

create_time: Option<Timestamp>

Output only. Timestamp when the example was created.

update_time: Option<Timestamp>

Output only. Timestamp when the example was last updated.

invalid: bool

Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.

etag: String

Etag used to ensure the object hasn’t changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

Implementations

impl Example

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 = Example::new().set_name(format!("projects/{project_id}/locations/{location_id}/apps/{app_id}/examples/{example_id}"));

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

Sets the value of display_name.

Example

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

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

Sets the value of description.

Example

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

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

Sets the value of entry_agent.

Example

let x = Example::new().set_entry_agent(format!("projects/{project_id}/locations/{location_id}/apps/{app_id}/agents/{agent_id}"));

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

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

Sets the value of messages.

Example

use google_cloud_ces_v1::model::Message;
let x = Example::new()
    .set_messages([
        Message::default()/* use setters */,
        Message::default()/* use (different) setters */,
    ]);

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

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

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

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

Sets the value of invalid.

Example

let x = Example::new().set_invalid(true);

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

Sets the value of etag.

Example

let x = Example::new().set_etag("example");

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl Default for Example

fn default() -> Example

Returns the “default value” for a type.

impl Message for Example

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Example

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Example