Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class DeleteToolRequest.
The request message for Tools.DeleteTool.
Generated from protobuf message google.cloud.dialogflow.cx.v3.DeleteToolRequest
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the Tool to be deleted. Format: |
↳ force |
bool
This field has no effect for Tools not being used. For Tools that are used: * * If |
getName
Required. The name of the Tool to be deleted.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the Tool to be deleted.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
This field has no effect for Tools not being used.
For Tools that are used:
- If
forceis set to false, an error will be returned with message indicating the referenced resources. - If
forceis set to true, Dialogflow will remove the tool, as well as any references to the tool.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
This field has no effect for Tools not being used.
For Tools that are used:
- If
forceis set to false, an error will be returned with message indicating the referenced resources. - If
forceis set to true, Dialogflow will remove the tool, as well as any references to the tool.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The name of the Tool to be deleted.
Format:
|
| Returns | |
|---|---|
| Type | Description |
DeleteToolRequest |
|