Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ConversationEvent.
Represents a notification sent to Pub/Sub subscribers for conversation
lifecycle events.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#conversation
defconversation()->::String
Returns
(::String) — The unique identifier of the conversation this notification
refers to.
Format: projects/<Project ID>/conversations/<Conversation ID>.
#conversation=
defconversation=(value)->::String
Parameter
value (::String) — The unique identifier of the conversation this notification
refers to.
Format: projects/<Project ID>/conversations/<Conversation ID>.
Returns
(::String) — The unique identifier of the conversation this notification
refers to.
Format: projects/<Project ID>/conversations/<Conversation ID>.
#error_status
deferror_status()->::Google::Rpc::Status
Returns
(::Google::Rpc::Status) — More detailed information about an error. Only set for type
UNRECOVERABLE_ERROR_IN_PHONE_CALL.
#error_status=
deferror_status=(value)->::Google::Rpc::Status
Parameter
value (::Google::Rpc::Status) — More detailed information about an error. Only set for type
UNRECOVERABLE_ERROR_IN_PHONE_CALL.
Returns
(::Google::Rpc::Status) — More detailed information about an error. Only set for type
UNRECOVERABLE_ERROR_IN_PHONE_CALL.
Note: The following fields are mutually exclusive: new_message_payload, new_recognition_result_payload. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: new_message_payload, new_recognition_result_payload. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: new_message_payload, new_recognition_result_payload. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: new_recognition_result_payload, new_message_payload. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: new_recognition_result_payload, new_message_payload. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: new_recognition_result_payload, new_message_payload. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ConversationEvent (v1.10.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.10.1 (latest)](/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.10.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.10.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.9.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.9.1/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.8.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.8.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.7.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.7.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.6.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.6.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.5.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.5.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.4.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.4.1/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.3.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.3.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.2.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.2.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.1.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.1.1/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [1.0.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.0.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.34.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.34.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.33.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.33.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.32.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.32.2/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.31.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.31.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.30.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.30.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.29.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.29.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.28.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.28.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.27.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.27.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.26.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.26.2/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.25.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.25.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.24.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.24.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.23.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.23.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.22.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.22.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.21.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.21.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.20.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.20.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.19.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.19.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.18.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.18.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.17.1](/ruby/docs/reference/google-cloud-dialogflow-v2/0.17.1/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.16.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.16.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.15.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.15.2/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.14.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.14.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.13.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.13.0/Google-Cloud-Dialogflow-V2-ConversationEvent)\n- [0.12.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.12.0/Google-Cloud-Dialogflow-V2-ConversationEvent) \nReference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ConversationEvent.\n\nRepresents a notification sent to Pub/Sub subscribers for conversation\nlifecycle events. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #conversation\n\n def conversation() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The unique identifier of the conversation this notification refers to. Format: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.\n\n### #conversation=\n\n def conversation=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The unique identifier of the conversation this notification refers to. Format: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`. \n**Returns**\n\n- (::String) --- The unique identifier of the conversation this notification refers to. Format: `projects/\u003cProject ID\u003e/conversations/\u003cConversation ID\u003e`.\n\n### #error_status\n\n def error_status() -\u003e ::Google::Rpc::Status\n\n**Returns**\n\n- ([::Google::Rpc::Status](./Google-Rpc-Status)) --- More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.\n\n### #error_status=\n\n def error_status=(value) -\u003e ::Google::Rpc::Status\n\n**Parameter**\n\n- **value** ([::Google::Rpc::Status](./Google-Rpc-Status)) --- More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL. \n**Returns**\n\n- ([::Google::Rpc::Status](./Google-Rpc-Status)) --- More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.\n\n### #new_message_payload\n\n def new_message_payload() -\u003e ::Google::Cloud::Dialogflow::V2::Message\n\n**Returns**\n\n- ([::Google::Cloud::Dialogflow::V2::Message](./Google-Cloud-Dialogflow-V2-Message)) --- Payload of NEW_MESSAGE event.\n\n\n Note: The following fields are mutually exclusive: `new_message_payload`, `new_recognition_result_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #new_message_payload=\n\n def new_message_payload=(value) -\u003e ::Google::Cloud::Dialogflow::V2::Message\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dialogflow::V2::Message](./Google-Cloud-Dialogflow-V2-Message)) --- Payload of NEW_MESSAGE event.\n\n\nNote: The following fields are mutually exclusive: `new_message_payload`, `new_recognition_result_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Dialogflow::V2::Message](./Google-Cloud-Dialogflow-V2-Message)) --- Payload of NEW_MESSAGE event.\n\n\n Note: The following fields are mutually exclusive: `new_message_payload`, `new_recognition_result_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #new_recognition_result_payload\n\n def new_recognition_result_payload() -\u003e ::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult\n\n**Returns**\n\n- ([::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult](./Google-Cloud-Dialogflow-V2-StreamingRecognitionResult)) --- Payload of NEW_RECOGNITION_RESULT event.\n\n\n Note: The following fields are mutually exclusive: `new_recognition_result_payload`, `new_message_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #new_recognition_result_payload=\n\n def new_recognition_result_payload=(value) -\u003e ::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult](./Google-Cloud-Dialogflow-V2-StreamingRecognitionResult)) --- Payload of NEW_RECOGNITION_RESULT event.\n\n\nNote: The following fields are mutually exclusive: `new_recognition_result_payload`, `new_message_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult](./Google-Cloud-Dialogflow-V2-StreamingRecognitionResult)) --- Payload of NEW_RECOGNITION_RESULT event.\n\n\n Note: The following fields are mutually exclusive: `new_recognition_result_payload`, `new_message_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #type\n\n def type() -\u003e ::Google::Cloud::Dialogflow::V2::ConversationEvent::Type\n\n**Returns**\n\n- ([::Google::Cloud::Dialogflow::V2::ConversationEvent::Type](./Google-Cloud-Dialogflow-V2-ConversationEvent-Type)) --- The type of the event that this notification refers to.\n\n### #type=\n\n def type=(value) -\u003e ::Google::Cloud::Dialogflow::V2::ConversationEvent::Type\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dialogflow::V2::ConversationEvent::Type](./Google-Cloud-Dialogflow-V2-ConversationEvent-Type)) --- The type of the event that this notification refers to. \n**Returns**\n\n- ([::Google::Cloud::Dialogflow::V2::ConversationEvent::Type](./Google-Cloud-Dialogflow-V2-ConversationEvent-Type)) --- The type of the event that this notification refers to."]]