Tools

google.cloud.dialogflow.cx.v3beta1. Tools

Represents a Tools

Constructor

new Tools(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Tools service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createTool(request, callback) → {undefined}

Calls CreateTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ICreateToolRequest

CreateToolRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.CreateToolCallback

Node-style callback called with the error, if any, and Tool
Returns:
Type Description
undefined

createTool(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Tool>}

Calls CreateTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ICreateToolRequest

CreateToolRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.Tool>

Promise

createToolVersion(request, callback) → {undefined}

Calls CreateToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ICreateToolVersionRequest

CreateToolVersionRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.CreateToolVersionCallback

Node-style callback called with the error, if any, and ToolVersion
Returns:
Type Description
undefined

createToolVersion(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ToolVersion>}

Calls CreateToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ICreateToolVersionRequest

CreateToolVersionRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.ToolVersion>

Promise

deleteTool(request, callback) → {undefined}

Calls DeleteTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IDeleteToolRequest

DeleteToolRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.DeleteToolCallback

Node-style callback called with the error, if any, and Empty
Returns:
Type Description
undefined

deleteTool(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IDeleteToolRequest

DeleteToolRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteToolVersion(request, callback) → {undefined}

Calls DeleteToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IDeleteToolVersionRequest

DeleteToolVersionRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.DeleteToolVersionCallback

Node-style callback called with the error, if any, and Empty
Returns:
Type Description
undefined

deleteToolVersion(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IDeleteToolVersionRequest

DeleteToolVersionRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

exportTools(request, callback) → {undefined}

Calls ExportTools.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IExportToolsRequest

ExportToolsRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.ExportToolsCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

exportTools(request) → {Promise.<google.longrunning.Operation>}

Calls ExportTools.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IExportToolsRequest

ExportToolsRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getTool(request, callback) → {undefined}

Calls GetTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetToolRequest

GetToolRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.GetToolCallback

Node-style callback called with the error, if any, and Tool
Returns:
Type Description
undefined

getTool(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Tool>}

Calls GetTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetToolRequest

GetToolRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.Tool>

Promise

getToolVersion(request, callback) → {undefined}

Calls GetToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetToolVersionRequest

GetToolVersionRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.GetToolVersionCallback

Node-style callback called with the error, if any, and ToolVersion
Returns:
Type Description
undefined

getToolVersion(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ToolVersion>}

Calls GetToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetToolVersionRequest

GetToolVersionRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.ToolVersion>

Promise

listToolVersions(request, callback) → {undefined}

Calls ListToolVersions.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IListToolVersionsRequest

ListToolVersionsRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.ListToolVersionsCallback

Node-style callback called with the error, if any, and ListToolVersionsResponse
Returns:
Type Description
undefined

listToolVersions(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ListToolVersionsResponse>}

Calls ListToolVersions.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IListToolVersionsRequest

ListToolVersionsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.ListToolVersionsResponse>

Promise

listTools(request, callback) → {undefined}

Calls ListTools.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IListToolsRequest

ListToolsRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.ListToolsCallback

Node-style callback called with the error, if any, and ListToolsResponse
Returns:
Type Description
undefined

listTools(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ListToolsResponse>}

Calls ListTools.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IListToolsRequest

ListToolsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.ListToolsResponse>

Promise

restoreToolVersion(request, callback) → {undefined}

Calls RestoreToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IRestoreToolVersionRequest

RestoreToolVersionRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.RestoreToolVersionCallback

Node-style callback called with the error, if any, and RestoreToolVersionResponse
Returns:
Type Description
undefined

restoreToolVersion(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.RestoreToolVersionResponse>}

Calls RestoreToolVersion.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IRestoreToolVersionRequest

RestoreToolVersionRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.RestoreToolVersionResponse>

Promise

updateTool(request, callback) → {undefined}

Calls UpdateTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IUpdateToolRequest

UpdateToolRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Tools.UpdateToolCallback

Node-style callback called with the error, if any, and Tool
Returns:
Type Description
undefined

updateTool(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Tool>}

Calls UpdateTool.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IUpdateToolRequest

UpdateToolRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.Tool>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Tools}

Creates new Tools service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
Tools

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

Type Definitions

CreateToolCallback(error, responseopt)

Callback as used by createTool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.Tool <optional>

Tool

CreateToolVersionCallback(error, responseopt)

Callback as used by createToolVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.ToolVersion <optional>

ToolVersion

DeleteToolCallback(error, responseopt)

Callback as used by deleteTool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

DeleteToolVersionCallback(error, responseopt)

Callback as used by deleteToolVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

ExportToolsCallback(error, responseopt)

Callback as used by exportTools.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

GetToolCallback(error, responseopt)

Callback as used by getTool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.Tool <optional>

Tool

GetToolVersionCallback(error, responseopt)

Callback as used by getToolVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.ToolVersion <optional>

ToolVersion

ListToolVersionsCallback(error, responseopt)

Callback as used by listToolVersions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.ListToolVersionsResponse <optional>

ListToolVersionsResponse

ListToolsCallback(error, responseopt)

Callback as used by listTools.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.ListToolsResponse <optional>

ListToolsResponse

RestoreToolVersionCallback(error, responseopt)

Callback as used by restoreToolVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.RestoreToolVersionResponse <optional>

RestoreToolVersionResponse

UpdateToolCallback(error, responseopt)

Callback as used by updateTool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.Tool <optional>

Tool