Class protos.google.cloud.dialogflow.cx.v3beta1.Playbooks (5.5.0)

Version latest

• 5.5.0 (latest)
• 5.1.0
• 5.0.1
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.3.1
• 4.2.0
• 4.0.0
• 3.4.2
• 3.2.1
• 3.1.2
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.1

Represents a Playbooks

Inheritance

$protobuf.rpc.Service > protos.google.cloud.dialogflow.cx.v3beta1.Playbooks

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Playbooks service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new Playbooks 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
Playbooks	RPC service. Useful where requests and/or responses are streamed.

createPlaybook(request, callback)

public createPlaybook(request: google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybookCallback): void;

Calls CreatePlaybook.

Parameters
Name	Description
request	ICreatePlaybookRequest CreatePlaybookRequest message or plain object
callback	CreatePlaybookCallback Node-style callback called with the error, if any, and Playbook

Returns
Type	Description
void

createPlaybook(request)

public createPlaybook(request: google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookRequest): Promise<google.cloud.dialogflow.cx.v3beta1.Playbook>;

Calls CreatePlaybook.

Parameter
Name	Description
request	ICreatePlaybookRequest CreatePlaybookRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.Playbook>	Promise

createPlaybookVersion(request, callback)

public createPlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookVersionRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybookVersionCallback): void;

Calls CreatePlaybookVersion.

Parameters
Name	Description
request	ICreatePlaybookVersionRequest CreatePlaybookVersionRequest message or plain object
callback	CreatePlaybookVersionCallback Node-style callback called with the error, if any, and PlaybookVersion

Returns
Type	Description
void

createPlaybookVersion(request)

public createPlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookVersionRequest): Promise<google.cloud.dialogflow.cx.v3beta1.PlaybookVersion>;

Calls CreatePlaybookVersion.

Parameter
Name	Description
request	ICreatePlaybookVersionRequest CreatePlaybookVersionRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.PlaybookVersion>	Promise

deletePlaybook(request, callback)

public deletePlaybook(request: google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybookCallback): void;

Calls DeletePlaybook.

Parameters
Name	Description
request	IDeletePlaybookRequest DeletePlaybookRequest message or plain object
callback	DeletePlaybookCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deletePlaybook(request)

public deletePlaybook(request: google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookRequest): Promise<google.protobuf.Empty>;

Calls DeletePlaybook.

Parameter
Name	Description
request	IDeletePlaybookRequest DeletePlaybookRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

deletePlaybookVersion(request, callback)

public deletePlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybookVersionCallback): void;

Calls DeletePlaybookVersion.

Parameters
Name	Description
request	IDeletePlaybookVersionRequest DeletePlaybookVersionRequest message or plain object
callback	DeletePlaybookVersionCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deletePlaybookVersion(request)

public deletePlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest): Promise<google.protobuf.Empty>;

Calls DeletePlaybookVersion.

Parameter
Name	Description
request	IDeletePlaybookVersionRequest DeletePlaybookVersionRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

exportPlaybook(request, callback)

public exportPlaybook(request: google.cloud.dialogflow.cx.v3beta1.IExportPlaybookRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.ExportPlaybookCallback): void;

Calls ExportPlaybook.

Parameters
Name	Description
request	IExportPlaybookRequest ExportPlaybookRequest message or plain object
callback	ExportPlaybookCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

exportPlaybook(request)

public exportPlaybook(request: google.cloud.dialogflow.cx.v3beta1.IExportPlaybookRequest): Promise<google.longrunning.Operation>;

Calls ExportPlaybook.

Parameter
Name	Description
request	IExportPlaybookRequest ExportPlaybookRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getPlaybook(request, callback)

public getPlaybook(request: google.cloud.dialogflow.cx.v3beta1.IGetPlaybookRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybookCallback): void;

Calls GetPlaybook.

Parameters
Name	Description
request	IGetPlaybookRequest GetPlaybookRequest message or plain object
callback	GetPlaybookCallback Node-style callback called with the error, if any, and Playbook

Returns
Type	Description
void

getPlaybook(request)

public getPlaybook(request: google.cloud.dialogflow.cx.v3beta1.IGetPlaybookRequest): Promise<google.cloud.dialogflow.cx.v3beta1.Playbook>;

Calls GetPlaybook.

Parameter
Name	Description
request	IGetPlaybookRequest GetPlaybookRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.Playbook>	Promise

getPlaybookVersion(request, callback)

public getPlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybookVersionCallback): void;

Calls GetPlaybookVersion.

Parameters
Name	Description
request	IGetPlaybookVersionRequest GetPlaybookVersionRequest message or plain object
callback	GetPlaybookVersionCallback Node-style callback called with the error, if any, and PlaybookVersion

Returns
Type	Description
void

getPlaybookVersion(request)

public getPlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest): Promise<google.cloud.dialogflow.cx.v3beta1.PlaybookVersion>;

Calls GetPlaybookVersion.

Parameter
Name	Description
request	IGetPlaybookVersionRequest GetPlaybookVersionRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.PlaybookVersion>	Promise

importPlaybook(request, callback)

public importPlaybook(request: google.cloud.dialogflow.cx.v3beta1.IImportPlaybookRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.ImportPlaybookCallback): void;

Calls ImportPlaybook.

Parameters
Name	Description
request	IImportPlaybookRequest ImportPlaybookRequest message or plain object
callback	ImportPlaybookCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

importPlaybook(request)

public importPlaybook(request: google.cloud.dialogflow.cx.v3beta1.IImportPlaybookRequest): Promise<google.longrunning.Operation>;

Calls ImportPlaybook.

Parameter
Name	Description
request	IImportPlaybookRequest ImportPlaybookRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

listPlaybooks(request, callback)

public listPlaybooks(request: google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybooksCallback): void;

Calls ListPlaybooks.

Parameters
Name	Description
request	IListPlaybooksRequest ListPlaybooksRequest message or plain object
callback	ListPlaybooksCallback Node-style callback called with the error, if any, and ListPlaybooksResponse

Returns
Type	Description
void

listPlaybooks(request)

public listPlaybooks(request: google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest): Promise<google.cloud.dialogflow.cx.v3beta1.ListPlaybooksResponse>;

Calls ListPlaybooks.

Parameter
Name	Description
request	IListPlaybooksRequest ListPlaybooksRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.ListPlaybooksResponse>	Promise

listPlaybookVersions(request, callback)

public listPlaybookVersions(request: google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybookVersionsCallback): void;

Calls ListPlaybookVersions.

Parameters
Name	Description
request	IListPlaybookVersionsRequest ListPlaybookVersionsRequest message or plain object
callback	ListPlaybookVersionsCallback Node-style callback called with the error, if any, and ListPlaybookVersionsResponse

Returns
Type	Description
void

listPlaybookVersions(request)

public listPlaybookVersions(request: google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest): Promise<google.cloud.dialogflow.cx.v3beta1.ListPlaybookVersionsResponse>;

Calls ListPlaybookVersions.

Parameter
Name	Description
request	IListPlaybookVersionsRequest ListPlaybookVersionsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.ListPlaybookVersionsResponse>	Promise

restorePlaybookVersion(request, callback)

public restorePlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.IRestorePlaybookVersionRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.RestorePlaybookVersionCallback): void;

Calls RestorePlaybookVersion.

Parameters
Name	Description
request	IRestorePlaybookVersionRequest RestorePlaybookVersionRequest message or plain object
callback	RestorePlaybookVersionCallback Node-style callback called with the error, if any, and RestorePlaybookVersionResponse

Returns
Type	Description
void

restorePlaybookVersion(request)

public restorePlaybookVersion(request: google.cloud.dialogflow.cx.v3beta1.IRestorePlaybookVersionRequest): Promise<google.cloud.dialogflow.cx.v3beta1.RestorePlaybookVersionResponse>;

Calls RestorePlaybookVersion.

Parameter
Name	Description
request	IRestorePlaybookVersionRequest RestorePlaybookVersionRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.RestorePlaybookVersionResponse>	Promise

updatePlaybook(request, callback)

public updatePlaybook(request: google.cloud.dialogflow.cx.v3beta1.IUpdatePlaybookRequest, callback: google.cloud.dialogflow.cx.v3beta1.Playbooks.UpdatePlaybookCallback): void;

Calls UpdatePlaybook.

Parameters
Name	Description
request	IUpdatePlaybookRequest UpdatePlaybookRequest message or plain object
callback	UpdatePlaybookCallback Node-style callback called with the error, if any, and Playbook

Returns
Type	Description
void

updatePlaybook(request)

public updatePlaybook(request: google.cloud.dialogflow.cx.v3beta1.IUpdatePlaybookRequest): Promise<google.cloud.dialogflow.cx.v3beta1.Playbook>;

Calls UpdatePlaybook.

Parameter
Name	Description
request	IUpdatePlaybookRequest UpdatePlaybookRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3beta1.Playbook>	Promise