Reference documentation and code samples for the Google Cloud Ces V1 Client class DeleteAgentRequest.
Request message for AgentService.DeleteAgent.
Generated from protobuf message google.cloud.ces.v1.DeleteAgentRequest
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 agent to delete. |
↳ force |
bool
Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. * * If |
↳ etag |
string
Optional. The current etag of the agent. 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 agent, deletion will be blocked and an ABORTED error will be returned. |
getName
Required. The resource name of the agent to delete.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of the agent to delete.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples.
- If
force = false, the deletion fails if other agents/examples reference it. - If
force = true, delete the agent and remove it from all referencing apps/agents/examples.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples.
- If
force = false, the deletion fails if other agents/examples reference it. - If
force = true, delete the agent and remove it from all referencing apps/agents/examples.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. The current etag of the agent. 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 agent, deletion will be blocked and an ABORTED error will be returned.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. The current etag of the agent. 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 agent, 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 agent to delete. Please see AgentServiceClient::agentName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
DeleteAgentRequest |
|