Struct google_api_proto::google::cloud::dialogflow::v2::Conversation

pub struct Conversation {
    pub name: String,
    pub lifecycle_state: i32,
    pub conversation_profile: String,
    pub phone_number: Option<ConversationPhoneNumber>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub conversation_stage: i32,
}

Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

Fields

name: String

Output only. Identifier. The unique identifier of this conversation. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

lifecycle_state: i32

Output only. The current state of the Conversation.

conversation_profile: String

Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

phone_number: Option<ConversationPhoneNumber>

Output only. It will not be empty if the conversation is to be connected over telephony.

start_time: Option<Timestamp>

Output only. The time the conversation was started.

end_time: Option<Timestamp>

Output only. The time the conversation was finished.

conversation_stage: i32

Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation.

If the conversation is created with the conversation profile that has Dialogflow config set, defaults to [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]; Otherwise, defaults to [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].

If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE], it skips [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE] stage and directly goes to [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].

Implementations

impl Conversation

pub fn lifecycle_state(&self) -> LifecycleState

Returns the enum value of lifecycle_state, or the default if the field is set to an invalid enum value.

pub fn set_lifecycle_state(&mut self, value: LifecycleState)

Sets lifecycle_state to the provided enum value.

pub fn conversation_stage(&self) -> ConversationStage

Returns the enum value of conversation_stage, or the default if the field is set to an invalid enum value.

pub fn set_conversation_stage(&mut self, value: ConversationStage)

Sets conversation_stage to the provided enum value.

Trait Implementations

impl Clone for Conversation

fn clone(&self) -> Conversation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Conversation

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

Formats the value using the given formatter.

impl Default for Conversation

fn default() -> Self

Returns the “default value” for a type.

impl Message for Conversation

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Conversation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Conversation