Reference documentation and code samples for the Google Cloud Ces V1 Client class DeleteToolRequest.
Request message for AgentService.DeleteTool.
Generated from protobuf message google.cloud.ces.v1.DeleteToolRequest
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name of the tool to delete. |
↳ force |
bool
Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * * If |
↳ etag |
string
Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned. |
getName
Required. The resource name of the tool to delete.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of the tool to delete.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples.
- If
force = false, the deletion will fail if any agents still reference the tool. - If
force = true, all existing references from agents will be removed and the tool will be deleted.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples.
- If
force = false, the deletion will fail if any agents still reference the tool. - If
force = true, all existing references from agents will be removed and the tool will be deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The resource name of the tool to delete. Please see AgentServiceClient::toolName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
DeleteToolRequest |
|