Playbooks

google.cloud.dialogflow.cx.v3beta1. Playbooks

Represents a Playbooks

Constructor

new Playbooks(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Playbooks 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

createPlaybook(request, callback) → {undefined}

Calls CreatePlaybook.

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

CreatePlaybookRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybookCallback

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

createPlaybook(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Playbook>}

Calls CreatePlaybook.

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

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

Promise

createPlaybookVersion(request, callback) → {undefined}

Calls CreatePlaybookVersion.

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

CreatePlaybookVersionRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybookVersionCallback

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

createPlaybookVersion(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.PlaybookVersion>}

Calls CreatePlaybookVersion.

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

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

Promise

deletePlaybook(request, callback) → {undefined}

Calls DeletePlaybook.

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

DeletePlaybookRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybookCallback

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

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

Calls DeletePlaybook.

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

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

Promise

deletePlaybookVersion(request, callback) → {undefined}

Calls DeletePlaybookVersion.

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

DeletePlaybookVersionRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybookVersionCallback

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

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

Calls DeletePlaybookVersion.

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

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

Promise

getPlaybook(request, callback) → {undefined}

Calls GetPlaybook.

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

GetPlaybookRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybookCallback

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

getPlaybook(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Playbook>}

Calls GetPlaybook.

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

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

Promise

getPlaybookVersion(request, callback) → {undefined}

Calls GetPlaybookVersion.

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

GetPlaybookVersionRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybookVersionCallback

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

getPlaybookVersion(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.PlaybookVersion>}

Calls GetPlaybookVersion.

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

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

Promise

listPlaybookVersions(request, callback) → {undefined}

Calls ListPlaybookVersions.

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

ListPlaybookVersionsRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybookVersionsCallback

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

listPlaybookVersions(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ListPlaybookVersionsResponse>}

Calls ListPlaybookVersions.

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

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

Promise

listPlaybooks(request, callback) → {undefined}

Calls ListPlaybooks.

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

ListPlaybooksRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybooksCallback

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

listPlaybooks(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ListPlaybooksResponse>}

Calls ListPlaybooks.

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

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

Promise

updatePlaybook(request, callback) → {undefined}

Calls UpdatePlaybook.

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

UpdatePlaybookRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Playbooks.UpdatePlaybookCallback

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

updatePlaybook(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Playbook>}

Calls UpdatePlaybook.

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

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

Promise

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

Creates new Playbooks 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
Playbooks

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

Type Definitions

CreatePlaybookCallback(error, responseopt)

Callback as used by createPlaybook.

Parameters:
Name Type Attributes Description
error Error | null

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

Playbook

CreatePlaybookVersionCallback(error, responseopt)

Callback as used by createPlaybookVersion.

Parameters:
Name Type Attributes Description
error Error | null

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

PlaybookVersion

DeletePlaybookCallback(error, responseopt)

Callback as used by deletePlaybook.

Parameters:
Name Type Attributes Description
error Error | null

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

Empty

DeletePlaybookVersionCallback(error, responseopt)

Callback as used by deletePlaybookVersion.

Parameters:
Name Type Attributes Description
error Error | null

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

Empty

GetPlaybookCallback(error, responseopt)

Callback as used by getPlaybook.

Parameters:
Name Type Attributes Description
error Error | null

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

Playbook

GetPlaybookVersionCallback(error, responseopt)

Callback as used by getPlaybookVersion.

Parameters:
Name Type Attributes Description
error Error | null

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

PlaybookVersion

ListPlaybookVersionsCallback(error, responseopt)

Callback as used by listPlaybookVersions.

Parameters:
Name Type Attributes Description
error Error | null

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

ListPlaybookVersionsResponse

ListPlaybooksCallback(error, responseopt)

Callback as used by listPlaybooks.

Parameters:
Name Type Attributes Description
error Error | null

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

ListPlaybooksResponse

UpdatePlaybookCallback(error, responseopt)

Callback as used by updatePlaybook.

Parameters:
Name Type Attributes Description
error Error | null

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

Playbook