Struct SessionEvent 

#[non_exhaustive]
pub struct SessionEvent {
    pub name: String,
    pub author: String,
    pub content: Option<Content>,
    pub invocation_id: String,
    pub actions: Option<EventActions>,
    pub timestamp: Option<Timestamp>,
    pub error_code: String,
    pub error_message: String,
    pub event_metadata: Option<EventMetadata>,
    pub raw_event: Option<Struct>,
    /* private fields */
}

Available on crate feature session-service only.

An event represents a message from either the user or agent.

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 resource name of the event. Format:projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}.

author: String

Required. The name of the agent that sent the event, or user.

content: Option<Content>

Optional. Content of the event provided by the author.

invocation_id: String

Required. The invocation id of the event, multiple events can have the same invocation id.

actions: Option<EventActions>

Optional. Actions executed by the agent.

timestamp: Option<Timestamp>

Required. Timestamp when the event was created on client side.

error_code: String

Optional. Error code if the response is an error. Code varies by model.

error_message: String

Optional. Error message if the response is an error.

event_metadata: Option<EventMetadata>

Optional. Metadata relating to this event.

raw_event: Option<Struct>

Optional. Weakly typed raw event data in proto struct format.

Implementations

impl SessionEvent

pub fn new() -> Self

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

Sets the value of name.

Example

let x = SessionEvent::new().set_name("example");

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

Sets the value of author.

Example

let x = SessionEvent::new().set_author("example");

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

where T: Into<Content>,

Sets the value of content.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = SessionEvent::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_aiplatform_v1::model::Content;
let x = SessionEvent::new().set_or_clear_content(Some(Content::default()/* use setters */));
let x = SessionEvent::new().set_or_clear_content(None::<Content>);

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

Sets the value of invocation_id.

Example

let x = SessionEvent::new().set_invocation_id("example");

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

where T: Into<EventActions>,

Sets the value of actions.

Example

use google_cloud_aiplatform_v1::model::EventActions;
let x = SessionEvent::new().set_actions(EventActions::default()/* use setters */);

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

where T: Into<EventActions>,

Sets or clears the value of actions.

Example

use google_cloud_aiplatform_v1::model::EventActions;
let x = SessionEvent::new().set_or_clear_actions(Some(EventActions::default()/* use setters */));
let x = SessionEvent::new().set_or_clear_actions(None::<EventActions>);

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

where T: Into<Timestamp>,

Sets the value of timestamp.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of timestamp.

Example

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

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

Sets the value of error_code.

Example

let x = SessionEvent::new().set_error_code("example");

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

Sets the value of error_message.

Example

let x = SessionEvent::new().set_error_message("example");

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

where T: Into<EventMetadata>,

Sets the value of event_metadata.

Example

use google_cloud_aiplatform_v1::model::EventMetadata;
let x = SessionEvent::new().set_event_metadata(EventMetadata::default()/* use setters */);

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

where T: Into<EventMetadata>,

Sets or clears the value of event_metadata.

Example

use google_cloud_aiplatform_v1::model::EventMetadata;
let x = SessionEvent::new().set_or_clear_event_metadata(Some(EventMetadata::default()/* use setters */));
let x = SessionEvent::new().set_or_clear_event_metadata(None::<EventMetadata>);

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

where T: Into<Struct>,

Sets the value of raw_event.

Example

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

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

where T: Into<Struct>,

Sets or clears the value of raw_event.

Example

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

Trait Implementations

impl Clone for SessionEvent

fn clone(&self) -> SessionEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionEvent

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

Formats the value using the given formatter.

impl Default for SessionEvent

fn default() -> SessionEvent

Returns the “default value” for a type.

impl Message for SessionEvent

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SessionEvent

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