Class protos.google.cloud.ces.v1beta.AgentService (0.4.1)

Represents an AgentService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.ces.v1beta.AgentService

Package

@google-cloud/ces

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new AgentService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

batchDeleteConversations(request, callback)

public batchDeleteConversations(request: google.cloud.ces.v1beta.IBatchDeleteConversationsRequest, callback: google.cloud.ces.v1beta.AgentService.BatchDeleteConversationsCallback): void;

Calls BatchDeleteConversations.

Parameters
Name Description
request IBatchDeleteConversationsRequest

BatchDeleteConversationsRequest message or plain object

callback BatchDeleteConversationsCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

batchDeleteConversations(request)

public batchDeleteConversations(request: google.cloud.ces.v1beta.IBatchDeleteConversationsRequest): Promise<google.longrunning.Operation>;

Calls BatchDeleteConversations.

Parameter
Name Description
request IBatchDeleteConversationsRequest

BatchDeleteConversationsRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): AgentService;

Creates new AgentService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
Type Description
AgentService

RPC service. Useful where requests and/or responses are streamed.

createAgent(request, callback)

public createAgent(request: google.cloud.ces.v1beta.ICreateAgentRequest, callback: google.cloud.ces.v1beta.AgentService.CreateAgentCallback): void;

Calls CreateAgent.

Parameters
Name Description
request ICreateAgentRequest

CreateAgentRequest message or plain object

callback CreateAgentCallback

Node-style callback called with the error, if any, and Agent

Returns
Type Description
void

createAgent(request)

public createAgent(request: google.cloud.ces.v1beta.ICreateAgentRequest): Promise<google.cloud.ces.v1beta.Agent>;

Calls CreateAgent.

Parameter
Name Description
request ICreateAgentRequest

CreateAgentRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Agent>

Promise

createApp(request, callback)

public createApp(request: google.cloud.ces.v1beta.ICreateAppRequest, callback: google.cloud.ces.v1beta.AgentService.CreateAppCallback): void;

Calls CreateApp.

Parameters
Name Description
request ICreateAppRequest

CreateAppRequest message or plain object

callback CreateAppCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

createApp(request)

public createApp(request: google.cloud.ces.v1beta.ICreateAppRequest): Promise<google.longrunning.Operation>;

Calls CreateApp.

Parameter
Name Description
request ICreateAppRequest

CreateAppRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createAppVersion(request, callback)

public createAppVersion(request: google.cloud.ces.v1beta.ICreateAppVersionRequest, callback: google.cloud.ces.v1beta.AgentService.CreateAppVersionCallback): void;

Calls CreateAppVersion.

Parameters
Name Description
request ICreateAppVersionRequest

CreateAppVersionRequest message or plain object

callback CreateAppVersionCallback

Node-style callback called with the error, if any, and AppVersion

Returns
Type Description
void

createAppVersion(request)

public createAppVersion(request: google.cloud.ces.v1beta.ICreateAppVersionRequest): Promise<google.cloud.ces.v1beta.AppVersion>;

Calls CreateAppVersion.

Parameter
Name Description
request ICreateAppVersionRequest

CreateAppVersionRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.AppVersion>

Promise

createDeployment(request, callback)

public createDeployment(request: google.cloud.ces.v1beta.ICreateDeploymentRequest, callback: google.cloud.ces.v1beta.AgentService.CreateDeploymentCallback): void;

Calls CreateDeployment.

Parameters
Name Description
request ICreateDeploymentRequest

CreateDeploymentRequest message or plain object

callback CreateDeploymentCallback

Node-style callback called with the error, if any, and Deployment

Returns
Type Description
void

createDeployment(request)

public createDeployment(request: google.cloud.ces.v1beta.ICreateDeploymentRequest): Promise<google.cloud.ces.v1beta.Deployment>;

Calls CreateDeployment.

Parameter
Name Description
request ICreateDeploymentRequest

CreateDeploymentRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Deployment>

Promise

createExample(request, callback)

public createExample(request: google.cloud.ces.v1beta.ICreateExampleRequest, callback: google.cloud.ces.v1beta.AgentService.CreateExampleCallback): void;

Calls CreateExample.

Parameters
Name Description
request ICreateExampleRequest

CreateExampleRequest message or plain object

callback CreateExampleCallback

Node-style callback called with the error, if any, and Example

Returns
Type Description
void

createExample(request)

public createExample(request: google.cloud.ces.v1beta.ICreateExampleRequest): Promise<google.cloud.ces.v1beta.Example>;

Calls CreateExample.

Parameter
Name Description
request ICreateExampleRequest

CreateExampleRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Example>

Promise

createGuardrail(request, callback)

public createGuardrail(request: google.cloud.ces.v1beta.ICreateGuardrailRequest, callback: google.cloud.ces.v1beta.AgentService.CreateGuardrailCallback): void;

Calls CreateGuardrail.

Parameters
Name Description
request ICreateGuardrailRequest

CreateGuardrailRequest message or plain object

callback CreateGuardrailCallback

Node-style callback called with the error, if any, and Guardrail

Returns
Type Description
void

createGuardrail(request)

public createGuardrail(request: google.cloud.ces.v1beta.ICreateGuardrailRequest): Promise<google.cloud.ces.v1beta.Guardrail>;

Calls CreateGuardrail.

Parameter
Name Description
request ICreateGuardrailRequest

CreateGuardrailRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Guardrail>

Promise

createTool(request, callback)

public createTool(request: google.cloud.ces.v1beta.ICreateToolRequest, callback: google.cloud.ces.v1beta.AgentService.CreateToolCallback): void;

Calls CreateTool.

Parameters
Name Description
request ICreateToolRequest

CreateToolRequest message or plain object

callback CreateToolCallback

Node-style callback called with the error, if any, and Tool

Returns
Type Description
void

createTool(request)

public createTool(request: google.cloud.ces.v1beta.ICreateToolRequest): Promise<google.cloud.ces.v1beta.Tool>;

Calls CreateTool.

Parameter
Name Description
request ICreateToolRequest

CreateToolRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Tool>

Promise

createToolset(request, callback)

public createToolset(request: google.cloud.ces.v1beta.ICreateToolsetRequest, callback: google.cloud.ces.v1beta.AgentService.CreateToolsetCallback): void;

Calls CreateToolset.

Parameters
Name Description
request ICreateToolsetRequest

CreateToolsetRequest message or plain object

callback CreateToolsetCallback

Node-style callback called with the error, if any, and Toolset

Returns
Type Description
void

createToolset(request)

public createToolset(request: google.cloud.ces.v1beta.ICreateToolsetRequest): Promise<google.cloud.ces.v1beta.Toolset>;

Calls CreateToolset.

Parameter
Name Description
request ICreateToolsetRequest

CreateToolsetRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Toolset>

Promise

deleteAgent(request, callback)

public deleteAgent(request: google.cloud.ces.v1beta.IDeleteAgentRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteAgentCallback): void;

Calls DeleteAgent.

Parameters
Name Description
request IDeleteAgentRequest

DeleteAgentRequest message or plain object

callback DeleteAgentCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteAgent(request)

public deleteAgent(request: google.cloud.ces.v1beta.IDeleteAgentRequest): Promise<google.protobuf.Empty>;

Calls DeleteAgent.

Parameter
Name Description
request IDeleteAgentRequest

DeleteAgentRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteApp(request, callback)

public deleteApp(request: google.cloud.ces.v1beta.IDeleteAppRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteAppCallback): void;

Calls DeleteApp.

Parameters
Name Description
request IDeleteAppRequest

DeleteAppRequest message or plain object

callback DeleteAppCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

deleteApp(request)

public deleteApp(request: google.cloud.ces.v1beta.IDeleteAppRequest): Promise<google.longrunning.Operation>;

Calls DeleteApp.

Parameter
Name Description
request IDeleteAppRequest

DeleteAppRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteAppVersion(request, callback)

public deleteAppVersion(request: google.cloud.ces.v1beta.IDeleteAppVersionRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteAppVersionCallback): void;

Calls DeleteAppVersion.

Parameters
Name Description
request IDeleteAppVersionRequest

DeleteAppVersionRequest message or plain object

callback DeleteAppVersionCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteAppVersion(request)

public deleteAppVersion(request: google.cloud.ces.v1beta.IDeleteAppVersionRequest): Promise<google.protobuf.Empty>;

Calls DeleteAppVersion.

Parameter
Name Description
request IDeleteAppVersionRequest

DeleteAppVersionRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteConversation(request, callback)

public deleteConversation(request: google.cloud.ces.v1beta.IDeleteConversationRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteConversationCallback): void;

Calls DeleteConversation.

Parameters
Name Description
request IDeleteConversationRequest

DeleteConversationRequest message or plain object

callback DeleteConversationCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteConversation(request)

public deleteConversation(request: google.cloud.ces.v1beta.IDeleteConversationRequest): Promise<google.protobuf.Empty>;

Calls DeleteConversation.

Parameter
Name Description
request IDeleteConversationRequest

DeleteConversationRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteDeployment(request, callback)

public deleteDeployment(request: google.cloud.ces.v1beta.IDeleteDeploymentRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteDeploymentCallback): void;

Calls DeleteDeployment.

Parameters
Name Description
request IDeleteDeploymentRequest

DeleteDeploymentRequest message or plain object

callback DeleteDeploymentCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteDeployment(request)

public deleteDeployment(request: google.cloud.ces.v1beta.IDeleteDeploymentRequest): Promise<google.protobuf.Empty>;

Calls DeleteDeployment.

Parameter
Name Description
request IDeleteDeploymentRequest

DeleteDeploymentRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteExample(request, callback)

public deleteExample(request: google.cloud.ces.v1beta.IDeleteExampleRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteExampleCallback): void;

Calls DeleteExample.

Parameters
Name Description
request IDeleteExampleRequest

DeleteExampleRequest message or plain object

callback DeleteExampleCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteExample(request)

public deleteExample(request: google.cloud.ces.v1beta.IDeleteExampleRequest): Promise<google.protobuf.Empty>;

Calls DeleteExample.

Parameter
Name Description
request IDeleteExampleRequest

DeleteExampleRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteGuardrail(request, callback)

public deleteGuardrail(request: google.cloud.ces.v1beta.IDeleteGuardrailRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteGuardrailCallback): void;

Calls DeleteGuardrail.

Parameters
Name Description
request IDeleteGuardrailRequest

DeleteGuardrailRequest message or plain object

callback DeleteGuardrailCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteGuardrail(request)

public deleteGuardrail(request: google.cloud.ces.v1beta.IDeleteGuardrailRequest): Promise<google.protobuf.Empty>;

Calls DeleteGuardrail.

Parameter
Name Description
request IDeleteGuardrailRequest

DeleteGuardrailRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteTool(request, callback)

public deleteTool(request: google.cloud.ces.v1beta.IDeleteToolRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteToolCallback): void;

Calls DeleteTool.

Parameters
Name Description
request IDeleteToolRequest

DeleteToolRequest message or plain object

callback DeleteToolCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteTool(request)

public deleteTool(request: google.cloud.ces.v1beta.IDeleteToolRequest): Promise<google.protobuf.Empty>;

Calls DeleteTool.

Parameter
Name Description
request IDeleteToolRequest

DeleteToolRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteToolset(request, callback)

public deleteToolset(request: google.cloud.ces.v1beta.IDeleteToolsetRequest, callback: google.cloud.ces.v1beta.AgentService.DeleteToolsetCallback): void;

Calls DeleteToolset.

Parameters
Name Description
request IDeleteToolsetRequest

DeleteToolsetRequest message or plain object

callback DeleteToolsetCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteToolset(request)

public deleteToolset(request: google.cloud.ces.v1beta.IDeleteToolsetRequest): Promise<google.protobuf.Empty>;

Calls DeleteToolset.

Parameter
Name Description
request IDeleteToolsetRequest

DeleteToolsetRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

exportApp(request, callback)

public exportApp(request: google.cloud.ces.v1beta.IExportAppRequest, callback: google.cloud.ces.v1beta.AgentService.ExportAppCallback): void;

Calls ExportApp.

Parameters
Name Description
request IExportAppRequest

ExportAppRequest message or plain object

callback ExportAppCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

exportApp(request)

public exportApp(request: google.cloud.ces.v1beta.IExportAppRequest): Promise<google.longrunning.Operation>;

Calls ExportApp.

Parameter
Name Description
request IExportAppRequest

ExportAppRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

generateAppResource(request, callback)

public generateAppResource(request: google.cloud.ces.v1beta.IGenerateAppResourceRequest, callback: google.cloud.ces.v1beta.AgentService.GenerateAppResourceCallback): void;

Calls GenerateAppResource.

Parameters
Name Description
request IGenerateAppResourceRequest

GenerateAppResourceRequest message or plain object

callback GenerateAppResourceCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

generateAppResource(request)

public generateAppResource(request: google.cloud.ces.v1beta.IGenerateAppResourceRequest): Promise<google.longrunning.Operation>;

Calls GenerateAppResource.

Parameter
Name Description
request IGenerateAppResourceRequest

GenerateAppResourceRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getAgent(request, callback)

public getAgent(request: google.cloud.ces.v1beta.IGetAgentRequest, callback: google.cloud.ces.v1beta.AgentService.GetAgentCallback): void;

Calls GetAgent.

Parameters
Name Description
request IGetAgentRequest

GetAgentRequest message or plain object

callback GetAgentCallback

Node-style callback called with the error, if any, and Agent

Returns
Type Description
void

getAgent(request)

public getAgent(request: google.cloud.ces.v1beta.IGetAgentRequest): Promise<google.cloud.ces.v1beta.Agent>;

Calls GetAgent.

Parameter
Name Description
request IGetAgentRequest

GetAgentRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Agent>

Promise

getApp(request, callback)

public getApp(request: google.cloud.ces.v1beta.IGetAppRequest, callback: google.cloud.ces.v1beta.AgentService.GetAppCallback): void;

Calls GetApp.

Parameters
Name Description
request IGetAppRequest

GetAppRequest message or plain object

callback GetAppCallback

Node-style callback called with the error, if any, and App

Returns
Type Description
void

getApp(request)

public getApp(request: google.cloud.ces.v1beta.IGetAppRequest): Promise<google.cloud.ces.v1beta.App>;

Calls GetApp.

Parameter
Name Description
request IGetAppRequest

GetAppRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.App>

Promise

getAppVersion(request, callback)

public getAppVersion(request: google.cloud.ces.v1beta.IGetAppVersionRequest, callback: google.cloud.ces.v1beta.AgentService.GetAppVersionCallback): void;

Calls GetAppVersion.

Parameters
Name Description
request IGetAppVersionRequest

GetAppVersionRequest message or plain object

callback GetAppVersionCallback

Node-style callback called with the error, if any, and AppVersion

Returns
Type Description
void

getAppVersion(request)

public getAppVersion(request: google.cloud.ces.v1beta.IGetAppVersionRequest): Promise<google.cloud.ces.v1beta.AppVersion>;

Calls GetAppVersion.

Parameter
Name Description
request IGetAppVersionRequest

GetAppVersionRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.AppVersion>

Promise

getChangelog(request, callback)

public getChangelog(request: google.cloud.ces.v1beta.IGetChangelogRequest, callback: google.cloud.ces.v1beta.AgentService.GetChangelogCallback): void;

Calls GetChangelog.

Parameters
Name Description
request IGetChangelogRequest

GetChangelogRequest message or plain object

callback GetChangelogCallback

Node-style callback called with the error, if any, and Changelog

Returns
Type Description
void

getChangelog(request)

public getChangelog(request: google.cloud.ces.v1beta.IGetChangelogRequest): Promise<google.cloud.ces.v1beta.Changelog>;

Calls GetChangelog.

Parameter
Name Description
request IGetChangelogRequest

GetChangelogRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Changelog>

Promise

getConversation(request, callback)

public getConversation(request: google.cloud.ces.v1beta.IGetConversationRequest, callback: google.cloud.ces.v1beta.AgentService.GetConversationCallback): void;

Calls GetConversation.

Parameters
Name Description
request IGetConversationRequest

GetConversationRequest message or plain object

callback GetConversationCallback

Node-style callback called with the error, if any, and Conversation

Returns
Type Description
void

getConversation(request)

public getConversation(request: google.cloud.ces.v1beta.IGetConversationRequest): Promise<google.cloud.ces.v1beta.Conversation>;

Calls GetConversation.

Parameter
Name Description
request IGetConversationRequest

GetConversationRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Conversation>

Promise

getDeployment(request, callback)

public getDeployment(request: google.cloud.ces.v1beta.IGetDeploymentRequest, callback: google.cloud.ces.v1beta.AgentService.GetDeploymentCallback): void;

Calls GetDeployment.

Parameters
Name Description
request IGetDeploymentRequest

GetDeploymentRequest message or plain object

callback GetDeploymentCallback

Node-style callback called with the error, if any, and Deployment

Returns
Type Description
void

getDeployment(request)

public getDeployment(request: google.cloud.ces.v1beta.IGetDeploymentRequest): Promise<google.cloud.ces.v1beta.Deployment>;

Calls GetDeployment.

Parameter
Name Description
request IGetDeploymentRequest

GetDeploymentRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Deployment>

Promise

getExample(request, callback)

public getExample(request: google.cloud.ces.v1beta.IGetExampleRequest, callback: google.cloud.ces.v1beta.AgentService.GetExampleCallback): void;

Calls GetExample.

Parameters
Name Description
request IGetExampleRequest

GetExampleRequest message or plain object

callback GetExampleCallback

Node-style callback called with the error, if any, and Example

Returns
Type Description
void

getExample(request)

public getExample(request: google.cloud.ces.v1beta.IGetExampleRequest): Promise<google.cloud.ces.v1beta.Example>;

Calls GetExample.

Parameter
Name Description
request IGetExampleRequest

GetExampleRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Example>

Promise

getGuardrail(request, callback)

public getGuardrail(request: google.cloud.ces.v1beta.IGetGuardrailRequest, callback: google.cloud.ces.v1beta.AgentService.GetGuardrailCallback): void;

Calls GetGuardrail.

Parameters
Name Description
request IGetGuardrailRequest

GetGuardrailRequest message or plain object

callback GetGuardrailCallback

Node-style callback called with the error, if any, and Guardrail

Returns
Type Description
void

getGuardrail(request)

public getGuardrail(request: google.cloud.ces.v1beta.IGetGuardrailRequest): Promise<google.cloud.ces.v1beta.Guardrail>;

Calls GetGuardrail.

Parameter
Name Description
request IGetGuardrailRequest

GetGuardrailRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Guardrail>

Promise

getSecuritySettings(request, callback)

public getSecuritySettings(request: google.cloud.ces.v1beta.IGetSecuritySettingsRequest, callback: google.cloud.ces.v1beta.AgentService.GetSecuritySettingsCallback): void;

Calls GetSecuritySettings.

Parameters
Name Description
request IGetSecuritySettingsRequest

GetSecuritySettingsRequest message or plain object

callback GetSecuritySettingsCallback

Node-style callback called with the error, if any, and SecuritySettings

Returns
Type Description
void

getSecuritySettings(request)

public getSecuritySettings(request: google.cloud.ces.v1beta.IGetSecuritySettingsRequest): Promise<google.cloud.ces.v1beta.SecuritySettings>;

Calls GetSecuritySettings.

Parameter
Name Description
request IGetSecuritySettingsRequest

GetSecuritySettingsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.SecuritySettings>

Promise

getTool(request, callback)

public getTool(request: google.cloud.ces.v1beta.IGetToolRequest, callback: google.cloud.ces.v1beta.AgentService.GetToolCallback): void;

Calls GetTool.

Parameters
Name Description
request IGetToolRequest

GetToolRequest message or plain object

callback GetToolCallback

Node-style callback called with the error, if any, and Tool

Returns
Type Description
void

getTool(request)

public getTool(request: google.cloud.ces.v1beta.IGetToolRequest): Promise<google.cloud.ces.v1beta.Tool>;

Calls GetTool.

Parameter
Name Description
request IGetToolRequest

GetToolRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Tool>

Promise

getToolset(request, callback)

public getToolset(request: google.cloud.ces.v1beta.IGetToolsetRequest, callback: google.cloud.ces.v1beta.AgentService.GetToolsetCallback): void;

Calls GetToolset.

Parameters
Name Description
request IGetToolsetRequest

GetToolsetRequest message or plain object

callback GetToolsetCallback

Node-style callback called with the error, if any, and Toolset

Returns
Type Description
void

getToolset(request)

public getToolset(request: google.cloud.ces.v1beta.IGetToolsetRequest): Promise<google.cloud.ces.v1beta.Toolset>;

Calls GetToolset.

Parameter
Name Description
request IGetToolsetRequest

GetToolsetRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Toolset>

Promise

importApp(request, callback)

public importApp(request: google.cloud.ces.v1beta.IImportAppRequest, callback: google.cloud.ces.v1beta.AgentService.ImportAppCallback): void;

Calls ImportApp.

Parameters
Name Description
request IImportAppRequest

ImportAppRequest message or plain object

callback ImportAppCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

importApp(request)

public importApp(request: google.cloud.ces.v1beta.IImportAppRequest): Promise<google.longrunning.Operation>;

Calls ImportApp.

Parameter
Name Description
request IImportAppRequest

ImportAppRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

listAgents(request, callback)

public listAgents(request: google.cloud.ces.v1beta.IListAgentsRequest, callback: google.cloud.ces.v1beta.AgentService.ListAgentsCallback): void;

Calls ListAgents.

Parameters
Name Description
request IListAgentsRequest

ListAgentsRequest message or plain object

callback ListAgentsCallback

Node-style callback called with the error, if any, and ListAgentsResponse

Returns
Type Description
void

listAgents(request)

public listAgents(request: google.cloud.ces.v1beta.IListAgentsRequest): Promise<google.cloud.ces.v1beta.ListAgentsResponse>;

Calls ListAgents.

Parameter
Name Description
request IListAgentsRequest

ListAgentsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListAgentsResponse>

Promise

listApps(request, callback)

public listApps(request: google.cloud.ces.v1beta.IListAppsRequest, callback: google.cloud.ces.v1beta.AgentService.ListAppsCallback): void;

Calls ListApps.

Parameters
Name Description
request IListAppsRequest

ListAppsRequest message or plain object

callback ListAppsCallback

Node-style callback called with the error, if any, and ListAppsResponse

Returns
Type Description
void

listApps(request)

public listApps(request: google.cloud.ces.v1beta.IListAppsRequest): Promise<google.cloud.ces.v1beta.ListAppsResponse>;

Calls ListApps.

Parameter
Name Description
request IListAppsRequest

ListAppsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListAppsResponse>

Promise

listAppVersions(request, callback)

public listAppVersions(request: google.cloud.ces.v1beta.IListAppVersionsRequest, callback: google.cloud.ces.v1beta.AgentService.ListAppVersionsCallback): void;

Calls ListAppVersions.

Parameters
Name Description
request IListAppVersionsRequest

ListAppVersionsRequest message or plain object

callback ListAppVersionsCallback

Node-style callback called with the error, if any, and ListAppVersionsResponse

Returns
Type Description
void

listAppVersions(request)

public listAppVersions(request: google.cloud.ces.v1beta.IListAppVersionsRequest): Promise<google.cloud.ces.v1beta.ListAppVersionsResponse>;

Calls ListAppVersions.

Parameter
Name Description
request IListAppVersionsRequest

ListAppVersionsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListAppVersionsResponse>

Promise

listChangelogs(request, callback)

public listChangelogs(request: google.cloud.ces.v1beta.IListChangelogsRequest, callback: google.cloud.ces.v1beta.AgentService.ListChangelogsCallback): void;

Calls ListChangelogs.

Parameters
Name Description
request IListChangelogsRequest

ListChangelogsRequest message or plain object

callback ListChangelogsCallback

Node-style callback called with the error, if any, and ListChangelogsResponse

Returns
Type Description
void

listChangelogs(request)

public listChangelogs(request: google.cloud.ces.v1beta.IListChangelogsRequest): Promise<google.cloud.ces.v1beta.ListChangelogsResponse>;

Calls ListChangelogs.

Parameter
Name Description
request IListChangelogsRequest

ListChangelogsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListChangelogsResponse>

Promise

listConversations(request, callback)

public listConversations(request: google.cloud.ces.v1beta.IListConversationsRequest, callback: google.cloud.ces.v1beta.AgentService.ListConversationsCallback): void;

Calls ListConversations.

Parameters
Name Description
request IListConversationsRequest

ListConversationsRequest message or plain object

callback ListConversationsCallback

Node-style callback called with the error, if any, and ListConversationsResponse

Returns
Type Description
void

listConversations(request)

public listConversations(request: google.cloud.ces.v1beta.IListConversationsRequest): Promise<google.cloud.ces.v1beta.ListConversationsResponse>;

Calls ListConversations.

Parameter
Name Description
request IListConversationsRequest

ListConversationsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListConversationsResponse>

Promise

listDeployments(request, callback)

public listDeployments(request: google.cloud.ces.v1beta.IListDeploymentsRequest, callback: google.cloud.ces.v1beta.AgentService.ListDeploymentsCallback): void;

Calls ListDeployments.

Parameters
Name Description
request IListDeploymentsRequest

ListDeploymentsRequest message or plain object

callback ListDeploymentsCallback

Node-style callback called with the error, if any, and ListDeploymentsResponse

Returns
Type Description
void

listDeployments(request)

public listDeployments(request: google.cloud.ces.v1beta.IListDeploymentsRequest): Promise<google.cloud.ces.v1beta.ListDeploymentsResponse>;

Calls ListDeployments.

Parameter
Name Description
request IListDeploymentsRequest

ListDeploymentsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListDeploymentsResponse>

Promise

listExamples(request, callback)

public listExamples(request: google.cloud.ces.v1beta.IListExamplesRequest, callback: google.cloud.ces.v1beta.AgentService.ListExamplesCallback): void;

Calls ListExamples.

Parameters
Name Description
request IListExamplesRequest

ListExamplesRequest message or plain object

callback ListExamplesCallback

Node-style callback called with the error, if any, and ListExamplesResponse

Returns
Type Description
void

listExamples(request)

public listExamples(request: google.cloud.ces.v1beta.IListExamplesRequest): Promise<google.cloud.ces.v1beta.ListExamplesResponse>;

Calls ListExamples.

Parameter
Name Description
request IListExamplesRequest

ListExamplesRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListExamplesResponse>

Promise

listGuardrails(request, callback)

public listGuardrails(request: google.cloud.ces.v1beta.IListGuardrailsRequest, callback: google.cloud.ces.v1beta.AgentService.ListGuardrailsCallback): void;

Calls ListGuardrails.

Parameters
Name Description
request IListGuardrailsRequest

ListGuardrailsRequest message or plain object

callback ListGuardrailsCallback

Node-style callback called with the error, if any, and ListGuardrailsResponse

Returns
Type Description
void

listGuardrails(request)

public listGuardrails(request: google.cloud.ces.v1beta.IListGuardrailsRequest): Promise<google.cloud.ces.v1beta.ListGuardrailsResponse>;

Calls ListGuardrails.

Parameter
Name Description
request IListGuardrailsRequest

ListGuardrailsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListGuardrailsResponse>

Promise

listTools(request, callback)

public listTools(request: google.cloud.ces.v1beta.IListToolsRequest, callback: google.cloud.ces.v1beta.AgentService.ListToolsCallback): void;

Calls ListTools.

Parameters
Name Description
request IListToolsRequest

ListToolsRequest message or plain object

callback ListToolsCallback

Node-style callback called with the error, if any, and ListToolsResponse

Returns
Type Description
void

listTools(request)

public listTools(request: google.cloud.ces.v1beta.IListToolsRequest): Promise<google.cloud.ces.v1beta.ListToolsResponse>;

Calls ListTools.

Parameter
Name Description
request IListToolsRequest

ListToolsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListToolsResponse>

Promise

listToolsets(request, callback)

public listToolsets(request: google.cloud.ces.v1beta.IListToolsetsRequest, callback: google.cloud.ces.v1beta.AgentService.ListToolsetsCallback): void;

Calls ListToolsets.

Parameters
Name Description
request IListToolsetsRequest

ListToolsetsRequest message or plain object

callback ListToolsetsCallback

Node-style callback called with the error, if any, and ListToolsetsResponse

Returns
Type Description
void

listToolsets(request)

public listToolsets(request: google.cloud.ces.v1beta.IListToolsetsRequest): Promise<google.cloud.ces.v1beta.ListToolsetsResponse>;

Calls ListToolsets.

Parameter
Name Description
request IListToolsetsRequest

ListToolsetsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.ListToolsetsResponse>

Promise

restoreAppVersion(request, callback)

public restoreAppVersion(request: google.cloud.ces.v1beta.IRestoreAppVersionRequest, callback: google.cloud.ces.v1beta.AgentService.RestoreAppVersionCallback): void;

Calls RestoreAppVersion.

Parameters
Name Description
request IRestoreAppVersionRequest

RestoreAppVersionRequest message or plain object

callback RestoreAppVersionCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

restoreAppVersion(request)

public restoreAppVersion(request: google.cloud.ces.v1beta.IRestoreAppVersionRequest): Promise<google.longrunning.Operation>;

Calls RestoreAppVersion.

Parameter
Name Description
request IRestoreAppVersionRequest

RestoreAppVersionRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateAgent(request, callback)

public updateAgent(request: google.cloud.ces.v1beta.IUpdateAgentRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateAgentCallback): void;

Calls UpdateAgent.

Parameters
Name Description
request IUpdateAgentRequest

UpdateAgentRequest message or plain object

callback UpdateAgentCallback

Node-style callback called with the error, if any, and Agent

Returns
Type Description
void

updateAgent(request)

public updateAgent(request: google.cloud.ces.v1beta.IUpdateAgentRequest): Promise<google.cloud.ces.v1beta.Agent>;

Calls UpdateAgent.

Parameter
Name Description
request IUpdateAgentRequest

UpdateAgentRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Agent>

Promise

updateApp(request, callback)

public updateApp(request: google.cloud.ces.v1beta.IUpdateAppRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateAppCallback): void;

Calls UpdateApp.

Parameters
Name Description
request IUpdateAppRequest

UpdateAppRequest message or plain object

callback UpdateAppCallback

Node-style callback called with the error, if any, and App

Returns
Type Description
void

updateApp(request)

public updateApp(request: google.cloud.ces.v1beta.IUpdateAppRequest): Promise<google.cloud.ces.v1beta.App>;

Calls UpdateApp.

Parameter
Name Description
request IUpdateAppRequest

UpdateAppRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.App>

Promise

updateDeployment(request, callback)

public updateDeployment(request: google.cloud.ces.v1beta.IUpdateDeploymentRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateDeploymentCallback): void;

Calls UpdateDeployment.

Parameters
Name Description
request IUpdateDeploymentRequest

UpdateDeploymentRequest message or plain object

callback UpdateDeploymentCallback

Node-style callback called with the error, if any, and Deployment

Returns
Type Description
void

updateDeployment(request)

public updateDeployment(request: google.cloud.ces.v1beta.IUpdateDeploymentRequest): Promise<google.cloud.ces.v1beta.Deployment>;

Calls UpdateDeployment.

Parameter
Name Description
request IUpdateDeploymentRequest

UpdateDeploymentRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Deployment>

Promise

updateExample(request, callback)

public updateExample(request: google.cloud.ces.v1beta.IUpdateExampleRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateExampleCallback): void;

Calls UpdateExample.

Parameters
Name Description
request IUpdateExampleRequest

UpdateExampleRequest message or plain object

callback UpdateExampleCallback

Node-style callback called with the error, if any, and Example

Returns
Type Description
void

updateExample(request)

public updateExample(request: google.cloud.ces.v1beta.IUpdateExampleRequest): Promise<google.cloud.ces.v1beta.Example>;

Calls UpdateExample.

Parameter
Name Description
request IUpdateExampleRequest

UpdateExampleRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Example>

Promise

updateGuardrail(request, callback)

public updateGuardrail(request: google.cloud.ces.v1beta.IUpdateGuardrailRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateGuardrailCallback): void;

Calls UpdateGuardrail.

Parameters
Name Description
request IUpdateGuardrailRequest

UpdateGuardrailRequest message or plain object

callback UpdateGuardrailCallback

Node-style callback called with the error, if any, and Guardrail

Returns
Type Description
void

updateGuardrail(request)

public updateGuardrail(request: google.cloud.ces.v1beta.IUpdateGuardrailRequest): Promise<google.cloud.ces.v1beta.Guardrail>;

Calls UpdateGuardrail.

Parameter
Name Description
request IUpdateGuardrailRequest

UpdateGuardrailRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Guardrail>

Promise

updateSecuritySettings(request, callback)

public updateSecuritySettings(request: google.cloud.ces.v1beta.IUpdateSecuritySettingsRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateSecuritySettingsCallback): void;

Calls UpdateSecuritySettings.

Parameters
Name Description
request IUpdateSecuritySettingsRequest

UpdateSecuritySettingsRequest message or plain object

callback UpdateSecuritySettingsCallback

Node-style callback called with the error, if any, and SecuritySettings

Returns
Type Description
void

updateSecuritySettings(request)

public updateSecuritySettings(request: google.cloud.ces.v1beta.IUpdateSecuritySettingsRequest): Promise<google.cloud.ces.v1beta.SecuritySettings>;

Calls UpdateSecuritySettings.

Parameter
Name Description
request IUpdateSecuritySettingsRequest

UpdateSecuritySettingsRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.SecuritySettings>

Promise

updateTool(request, callback)

public updateTool(request: google.cloud.ces.v1beta.IUpdateToolRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateToolCallback): void;

Calls UpdateTool.

Parameters
Name Description
request IUpdateToolRequest

UpdateToolRequest message or plain object

callback UpdateToolCallback

Node-style callback called with the error, if any, and Tool

Returns
Type Description
void

updateTool(request)

public updateTool(request: google.cloud.ces.v1beta.IUpdateToolRequest): Promise<google.cloud.ces.v1beta.Tool>;

Calls UpdateTool.

Parameter
Name Description
request IUpdateToolRequest

UpdateToolRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Tool>

Promise

updateToolset(request, callback)

public updateToolset(request: google.cloud.ces.v1beta.IUpdateToolsetRequest, callback: google.cloud.ces.v1beta.AgentService.UpdateToolsetCallback): void;

Calls UpdateToolset.

Parameters
Name Description
request IUpdateToolsetRequest

UpdateToolsetRequest message or plain object

callback UpdateToolsetCallback

Node-style callback called with the error, if any, and Toolset

Returns
Type Description
void

updateToolset(request)

public updateToolset(request: google.cloud.ces.v1beta.IUpdateToolsetRequest): Promise<google.cloud.ces.v1beta.Toolset>;

Calls UpdateToolset.

Parameter
Name Description
request IUpdateToolsetRequest

UpdateToolsetRequest message or plain object

Returns
Type Description
Promise<google.cloud.ces.v1beta.Toolset>

Promise