# Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ToolCall (v1.16.1) 1.16.1 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.0 1.10.1 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.1 1.0.0 0.34.0 0.33.0 0.32.2 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.1 0.16.0 0.15.2 0.14.0 0.13.0 0.12.0 Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ToolCall. Represents a call of a specific tool's action with the specified inputs. ## Inherits - Object ## Extended By - Google::Protobuf::MessageExts::ClassMethods ## Includes - Google::Protobuf::MessageExts ## Methods ### #action def action() -> ::String **Returns** - (::String) --- Optional. The name of the tool's action associated with this call. ### #action= def action=(value) -> ::String **Parameter** - **value** (::String) --- Optional. The name of the tool's action associated with this call. **Returns** - (::String) --- Optional. The name of the tool's action associated with this call. ### #answer_record def answer_record() -> ::String **Returns** - (::String) --- Optional. The answer record associated with this tool call. ### #answer_record= def answer_record=(value) -> ::String **Parameter** - **value** (::String) --- Optional. The answer record associated with this tool call. **Returns** - (::String) --- Optional. The answer record associated with this tool call. ### #ces_app def ces_app() -> ::String **Returns** - (::String) --- Optional. CES app name for this call. Format: `projects//locations//apps/`. Note: The following fields are mutually exclusive: `ces_app`, `tool`, `ces_tool`, `ces_toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #ces_app= def ces_app=(value) -> ::String **Parameter** - **value** (::String) --- Optional. CES app name for this call. Format: `projects//locations//apps/`. Note: The following fields are mutually exclusive: `ces_app`, `tool`, `ces_tool`, `ces_toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared. **Returns** - (::String) --- Optional. CES app name for this call. Format: `projects//locations//apps/`. Note: The following fields are mutually exclusive: `ces_app`, `tool`, `ces_tool`, `ces_toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #ces_tool def ces_tool() -> ::String **Returns** - (::String) --- Optional. CES tool name for this call. Format: `projects//locations//apps//tools/`. Note: The following fields are mutually exclusive: `ces_tool`, `tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #ces_tool= def ces_tool=(value) -> ::String **Parameter** - **value** (::String) --- Optional. CES tool name for this call. Format: `projects//locations//apps//tools/`. Note: The following fields are mutually exclusive: `ces_tool`, `tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. **Returns** - (::String) --- Optional. CES tool name for this call. Format: `projects//locations//apps//tools/`. Note: The following fields are mutually exclusive: `ces_tool`, `tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #ces_toolset def ces_toolset() -> ::String **Returns** - (::String) --- Optional. CES toolset name for this call. Format: `projects//locations//apps//toolsets/ToolsetID>`. Note: The following fields are mutually exclusive: `ces_toolset`, `tool`, `ces_tool`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #ces_toolset= def ces_toolset=(value) -> ::String **Parameter** - **value** (::String) --- Optional. CES toolset name for this call. Format: `projects//locations//apps//toolsets/ToolsetID>`. Note: The following fields are mutually exclusive: `ces_toolset`, `tool`, `ces_tool`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. **Returns** - (::String) --- Optional. CES toolset name for this call. Format: `projects//locations//apps//toolsets/ToolsetID>`. Note: The following fields are mutually exclusive: `ces_toolset`, `tool`, `ces_tool`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #create_time def create_time() -> ::Google::Protobuf::Timestamp **Returns** - ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Protobuf-Timestamp)) --- Output only. Create time of the tool call. ### #input_parameters def input_parameters() -> ::Google::Protobuf::Struct **Returns** - ([::Google::Protobuf::Struct](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Protobuf-Struct)) --- Optional. The action's input parameters. ### #input_parameters= def input_parameters=(value) -> ::Google::Protobuf::Struct **Parameter** - **value** ([::Google::Protobuf::Struct](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Protobuf-Struct)) --- Optional. The action's input parameters. **Returns** - ([::Google::Protobuf::Struct](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Protobuf-Struct)) --- Optional. The action's input parameters. ### #state def state() -> ::Google::Cloud::Dialogflow::V2::ToolCall::State **Returns** - ([::Google::Cloud::Dialogflow::V2::ToolCall::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ToolCall-State)) --- Output only. State of the tool call. ### #tool def tool() -> ::String **Returns** - (::String) --- Optional. The [tool](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-Tool "Google::Cloud::Dialogflow::V2::Tool (class)") associated with this call. Format: `projects//locations//tools/`. Note: The following fields are mutually exclusive: `tool`, `ces_tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #tool= def tool=(value) -> ::String **Parameter** - **value** (::String) --- Optional. The [tool](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-Tool "Google::Cloud::Dialogflow::V2::Tool (class)") associated with this call. Format: `projects//locations//tools/`. Note: The following fields are mutually exclusive: `tool`, `ces_tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. **Returns** - (::String) --- Optional. The [tool](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-Tool "Google::Cloud::Dialogflow::V2::Tool (class)") associated with this call. Format: `projects//locations//tools/`. Note: The following fields are mutually exclusive: `tool`, `ces_tool`, `ces_toolset`, `ces_app`. If a field in that set is populated, all other fields in the set will automatically be cleared. ### #tool_display_details def tool_display_details() -> ::String **Returns** - (::String) --- Optional. A human readable description of the tool. ### #tool_display_details= def tool_display_details=(value) -> ::String **Parameter** - **value** (::String) --- Optional. A human readable description of the tool. **Returns** - (::String) --- Optional. A human readable description of the tool. ### #tool_display_name def tool_display_name() -> ::String **Returns** - (::String) --- Optional. A human readable short name of the tool, to be shown on the UI. ### #tool_display_name= def tool_display_name=(value) -> ::String **Parameter** - **value** (::String) --- Optional. A human readable short name of the tool, to be shown on the UI. **Returns** - (::String) --- Optional. A human readable short name of the tool, to be shown on the UI.