Dialogflow v3 API - Class Playbooks.PlaybooksBase (3.0.0)

Version latest

• 3.0.0 (latest)
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(Playbooks), "BindService")]
public abstract class Playbooks.PlaybooksBase

Reference documentation and code samples for the Dialogflow v3 API class Playbooks.PlaybooksBase.

Base class for server-side implementations of Playbooks

Inheritance

object > Playbooks.PlaybooksBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Methods

CreatePlaybook(CreatePlaybookRequest, ServerCallContext)

public virtual Task<Playbook> CreatePlaybook(CreatePlaybookRequest request, ServerCallContext context)

Creates a playbook in a specified agent.

Parameters
Name	Description
request	CreatePlaybookRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPlaybook	The response to send back to the client (wrapped by a task).

CreatePlaybookVersion(CreatePlaybookVersionRequest, ServerCallContext)

public virtual Task<PlaybookVersion> CreatePlaybookVersion(CreatePlaybookVersionRequest request, ServerCallContext context)

Creates a version for the specified Playbook.

Parameters
Name	Description
request	CreatePlaybookVersionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPlaybookVersion	The response to send back to the client (wrapped by a task).

DeletePlaybook(DeletePlaybookRequest, ServerCallContext)

public virtual Task<Empty> DeletePlaybook(DeletePlaybookRequest request, ServerCallContext context)

Deletes a specified playbook.

Parameters
Name	Description
request	DeletePlaybookRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeletePlaybookVersion(DeletePlaybookVersionRequest, ServerCallContext)

public virtual Task<Empty> DeletePlaybookVersion(DeletePlaybookVersionRequest request, ServerCallContext context)

Deletes the specified version of the Playbook.

Parameters
Name	Description
request	DeletePlaybookVersionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

ExportPlaybook(ExportPlaybookRequest, ServerCallContext)

public virtual Task<Operation> ExportPlaybook(ExportPlaybookRequest request, ServerCallContext context)

Exports the specified playbook to a binary file.

Note that resources (e.g. examples, tools) that the playbook references will also be exported.

Parameters
Name	Description
request	ExportPlaybookRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetPlaybook(GetPlaybookRequest, ServerCallContext)

public virtual Task<Playbook> GetPlaybook(GetPlaybookRequest request, ServerCallContext context)

Retrieves the specified Playbook.

Parameters
Name	Description
request	GetPlaybookRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPlaybook	The response to send back to the client (wrapped by a task).

GetPlaybookVersion(GetPlaybookVersionRequest, ServerCallContext)

public virtual Task<PlaybookVersion> GetPlaybookVersion(GetPlaybookVersionRequest request, ServerCallContext context)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
request	GetPlaybookVersionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPlaybookVersion	The response to send back to the client (wrapped by a task).

ImportPlaybook(ImportPlaybookRequest, ServerCallContext)

public virtual Task<Operation> ImportPlaybook(ImportPlaybookRequest request, ServerCallContext context)

Imports the specified playbook to the specified agent from a binary file.

Parameters
Name	Description
request	ImportPlaybookRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListPlaybookVersions(ListPlaybookVersionsRequest, ServerCallContext)

public virtual Task<ListPlaybookVersionsResponse> ListPlaybookVersions(ListPlaybookVersionsRequest request, ServerCallContext context)

Lists versions for the specified Playbook.

Parameters
Name	Description
request	ListPlaybookVersionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListPlaybookVersionsResponse	The response to send back to the client (wrapped by a task).

ListPlaybooks(ListPlaybooksRequest, ServerCallContext)

public virtual Task<ListPlaybooksResponse> ListPlaybooks(ListPlaybooksRequest request, ServerCallContext context)

Returns a list of playbooks in the specified agent.

Parameters
Name	Description
request	ListPlaybooksRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListPlaybooksResponse	The response to send back to the client (wrapped by a task).

RestorePlaybookVersion(RestorePlaybookVersionRequest, ServerCallContext)

public virtual Task<RestorePlaybookVersionResponse> RestorePlaybookVersion(RestorePlaybookVersionRequest request, ServerCallContext context)

Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.

Parameters
Name	Description
request	RestorePlaybookVersionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRestorePlaybookVersionResponse	The response to send back to the client (wrapped by a task).

UpdatePlaybook(UpdatePlaybookRequest, ServerCallContext)

public virtual Task<Playbook> UpdatePlaybook(UpdatePlaybookRequest request, ServerCallContext context)

Updates the specified Playbook.

Parameters
Name	Description
request	UpdatePlaybookRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPlaybook	The response to send back to the client (wrapped by a task).