Struct Session 

#[non_exhaustive]
pub struct Session {
    pub name: String,
    pub display_name: String,
    pub state: State,
    pub user_pseudo_id: String,
    pub turns: Vec<Turn>,
    pub labels: Vec<String>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub is_pinned: bool,
    /* private fields */
}

Available on crate features conversational-search-service or session-service only.

External session proto definition.

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. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*

display_name: String

Optional. The display name of the session.

This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.

state: State

The state of the session.

user_pseudo_id: String

A unique identifier for tracking users.

turns: Vec<Turn>

Turns.

labels: Vec<String>

Optional. The labels for the session. Can be set as filter in ListSessionsRequest.

start_time: Option<Timestamp>

Output only. The time the session started.

end_time: Option<Timestamp>

Output only. The time the session finished.

is_pinned: bool

Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.

Implementations

impl Session

pub fn new() -> Self

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

Sets the value of name.

Example

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

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

Sets the value of display_name.

Example

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

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

Sets the value of state.

Example

use google_cloud_discoveryengine_v1::model::session::State;
let x0 = Session::new().set_state(State::InProgress);

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

Sets the value of user_pseudo_id.

Example

let x = Session::new().set_user_pseudo_id("example");

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

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

Sets the value of turns.

Example

use google_cloud_discoveryengine_v1::model::session::Turn;
let x = Session::new()
    .set_turns([
        Turn::default()/* use setters */,
        Turn::default()/* use (different) setters */,
    ]);

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

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

Sets the value of labels.

Example

let x = Session::new().set_labels(["a", "b", "c"]);

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of end_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

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

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

Sets the value of is_pinned.

Example

let x = Session::new().set_is_pinned(true);

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Session

Returns the “default value” for a type.

impl Message for Session

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Session

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