Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::DeleteToolRequest (v1.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::DeleteToolRequest.

The request message for Tools.DeleteTool.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#force

def force() -> ::Boolean
Returns
  • (::Boolean) —

    This field has no effect for Tools not being used. For Tools that are used:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the tool, as well as any references to the tool.

#force=

def force=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    This field has no effect for Tools not being used. For Tools that are used:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the tool, as well as any references to the tool.
Returns
  • (::Boolean) —

    This field has no effect for Tools not being used. For Tools that are used:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the tool, as well as any references to the tool.

#name

def name() -> ::String
Returns
  • (::String) — Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
Returns
  • (::String) — Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.