Struct ConversationEvent 

#[non_exhaustive]
pub struct ConversationEvent {
    pub conversation: String,
    pub type: Type,
    pub error_status: Option<Status>,
    pub payload: Option<Payload>,
    /* private fields */
}

Available on crate features agents and answer-records and contexts and conversation-datasets and conversation-models and conversation-profiles and conversations and documents and encryption-spec-service and entity-types and environments and fulfillments and generators and intents and knowledge-bases and participants and session-entity-types and sessions and versions only.

Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.

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.

conversation: String

The unique identifier of the conversation this notification refers to. Format: projects/<Project ID>/conversations/<Conversation ID>.

type: Type

The type of the event that this notification refers to.

error_status: Option<Status>

More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.

payload: Option<Payload>

Payload of conversation event.

Implementations

impl ConversationEvent

pub fn new() -> Self

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

Sets the value of conversation.

Example

let x = ConversationEvent::new().set_conversation("example");

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

Example

use google_cloud_dialogflow_v2::model::conversation_event::Type;
let x0 = ConversationEvent::new().set_type(Type::ConversationStarted);
let x1 = ConversationEvent::new().set_type(Type::ConversationFinished);
let x2 = ConversationEvent::new().set_type(Type::HumanInterventionNeeded);

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

where T: Into<Status>,

Sets the value of error_status.

Example

use rpc::model::Status;
let x = ConversationEvent::new().set_error_status(Status::default()/* use setters */);

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

where T: Into<Status>,

Sets or clears the value of error_status.

Example

use rpc::model::Status;
let x = ConversationEvent::new().set_or_clear_error_status(Some(Status::default()/* use setters */));
let x = ConversationEvent::new().set_or_clear_error_status(None::<Status>);

pub fn set_payload<T: Into<Option<Payload>>>(self, v: T) -> Self

Sets the value of payload.

Note that all the setters affecting payload are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::Message;
let x = ConversationEvent::new().set_payload(Some(
    google_cloud_dialogflow_v2::model::conversation_event::Payload::NewMessagePayload(Message::default().into())));

pub fn new_message_payload(&self) -> Option<&Box<Message>>

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

pub fn set_new_message_payload<T: Into<Box<Message>>>(self, v: T) -> Self

Sets the value of payload to hold a NewMessagePayload.

Note that all the setters affecting payload are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::Message;
let x = ConversationEvent::new().set_new_message_payload(Message::default()/* use setters */);
assert!(x.new_message_payload().is_some());
assert!(x.new_recognition_result_payload().is_none());

pub fn new_recognition_result_payload( &self, ) -> Option<&Box<StreamingRecognitionResult>>

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

pub fn set_new_recognition_result_payload<T: Into<Box<StreamingRecognitionResult>>>( self, v: T, ) -> Self

Sets the value of payload to hold a NewRecognitionResultPayload.

Note that all the setters affecting payload are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::StreamingRecognitionResult;
let x = ConversationEvent::new().set_new_recognition_result_payload(StreamingRecognitionResult::default()/* use setters */);
assert!(x.new_recognition_result_payload().is_some());
assert!(x.new_message_payload().is_none());

Trait Implementations

impl Clone for ConversationEvent

fn clone(&self) -> ConversationEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConversationEvent

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

Formats the value using the given formatter.

impl Default for ConversationEvent

fn default() -> ConversationEvent

Returns the “default value” for a type.

impl Message for ConversationEvent

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ConversationEvent

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