Dialogflow v3 API - Class PlaybooksClientImpl (3.0.0) 

public sealed class PlaybooksClientImpl : PlaybooksClient

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

Playbooks client wrapper implementation, for convenient use.

Inheritance

object > PlaybooksClient > PlaybooksClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Playbooks][google.cloud.dialogflow.cx.v3.Playbook].

Constructors

PlaybooksClientImpl(PlaybooksClient, PlaybooksSettings, ILogger)

public PlaybooksClientImpl(Playbooks.PlaybooksClient grpcClient, PlaybooksSettings settings, ILogger logger)

Constructs a client wrapper for the Playbooks service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient PlaybooksPlaybooksClient

The underlying gRPC client.
settings PlaybooksSettings

The base PlaybooksSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

ExportPlaybookOperationsClient

public override OperationsClient ExportPlaybookOperationsClient { get; }

The long-running operations client for ExportPlaybook.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Playbooks.PlaybooksClient GrpcClient { get; }

The underlying gRPC Playbooks client

Property Value
Type Description
PlaybooksPlaybooksClient
Overrides

ImportPlaybookOperationsClient

public override OperationsClient ImportPlaybookOperationsClient { get; }

The long-running operations client for ImportPlaybook.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CreatePlaybook(CreatePlaybookRequest, CallSettings)

public override Playbook CreatePlaybook(CreatePlaybookRequest request, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name Description
request CreatePlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Playbook

The RPC response.
Overrides

CreatePlaybookAsync(CreatePlaybookRequest, CallSettings)

public override Task<Playbook> CreatePlaybookAsync(CreatePlaybookRequest request, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name Description
request CreatePlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlaybook

A Task containing the RPC response.
Overrides

CreatePlaybookVersion(CreatePlaybookVersionRequest, CallSettings)

public override PlaybookVersion CreatePlaybookVersion(CreatePlaybookVersionRequest request, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name Description
request CreatePlaybookVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PlaybookVersion

The RPC response.
Overrides

CreatePlaybookVersionAsync(CreatePlaybookVersionRequest, CallSettings)

public override Task<PlaybookVersion> CreatePlaybookVersionAsync(CreatePlaybookVersionRequest request, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name Description
request CreatePlaybookVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlaybookVersion

A Task containing the RPC response.
Overrides

DeletePlaybook(DeletePlaybookRequest, CallSettings)

public override void DeletePlaybook(DeletePlaybookRequest request, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name Description
request DeletePlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeletePlaybookAsync(DeletePlaybookRequest, CallSettings)

public override Task DeletePlaybookAsync(DeletePlaybookRequest request, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name Description
request DeletePlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeletePlaybookVersion(DeletePlaybookVersionRequest, CallSettings)

public override void DeletePlaybookVersion(DeletePlaybookVersionRequest request, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name Description
request DeletePlaybookVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeletePlaybookVersionAsync(DeletePlaybookVersionRequest, CallSettings)

public override Task DeletePlaybookVersionAsync(DeletePlaybookVersionRequest request, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name Description
request DeletePlaybookVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

ExportPlaybook(ExportPlaybookRequest, CallSettings)

public override Operation<ExportPlaybookResponse, Struct> ExportPlaybook(ExportPlaybookRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExportPlaybookResponseStruct

The RPC response.
Overrides

ExportPlaybookAsync(ExportPlaybookRequest, CallSettings)

public override Task<Operation<ExportPlaybookResponse, Struct>> ExportPlaybookAsync(ExportPlaybookRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExportPlaybookResponseStruct

A Task containing the RPC response.
Overrides

GetPlaybook(GetPlaybookRequest, CallSettings)

public override Playbook GetPlaybook(GetPlaybookRequest request, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name Description
request GetPlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Playbook

The RPC response.
Overrides

GetPlaybookAsync(GetPlaybookRequest, CallSettings)

public override Task<Playbook> GetPlaybookAsync(GetPlaybookRequest request, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name Description
request GetPlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlaybook

A Task containing the RPC response.
Overrides

GetPlaybookVersion(GetPlaybookVersionRequest, CallSettings)

public override PlaybookVersion GetPlaybookVersion(GetPlaybookVersionRequest request, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name Description
request GetPlaybookVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PlaybookVersion

The RPC response.
Overrides

GetPlaybookVersionAsync(GetPlaybookVersionRequest, CallSettings)

public override Task<PlaybookVersion> GetPlaybookVersionAsync(GetPlaybookVersionRequest request, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name Description
request GetPlaybookVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlaybookVersion

A Task containing the RPC response.
Overrides

ImportPlaybook(ImportPlaybookRequest, CallSettings)

public override Operation<ImportPlaybookResponse, Struct> ImportPlaybook(ImportPlaybookRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ImportPlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationImportPlaybookResponseStruct

The RPC response.
Overrides

ImportPlaybookAsync(ImportPlaybookRequest, CallSettings)

public override Task<Operation<ImportPlaybookResponse, Struct>> ImportPlaybookAsync(ImportPlaybookRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ImportPlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationImportPlaybookResponseStruct

A Task containing the RPC response.
Overrides

ListPlaybookVersions(ListPlaybookVersionsRequest, CallSettings)

public override PagedEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersions(ListPlaybookVersionsRequest request, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name Description
request ListPlaybookVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListPlaybookVersionsResponsePlaybookVersion

A pageable sequence of PlaybookVersion resources.
Overrides

ListPlaybookVersionsAsync(ListPlaybookVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersionsAsync(ListPlaybookVersionsRequest request, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name Description
request ListPlaybookVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListPlaybookVersionsResponsePlaybookVersion

A pageable asynchronous sequence of PlaybookVersion resources.
Overrides

ListPlaybooks(ListPlaybooksRequest, CallSettings)

public override PagedEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooks(ListPlaybooksRequest request, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name Description
request ListPlaybooksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListPlaybooksResponsePlaybook

A pageable sequence of Playbook resources.
Overrides

ListPlaybooksAsync(ListPlaybooksRequest, CallSettings)

public override PagedAsyncEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooksAsync(ListPlaybooksRequest request, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name Description
request ListPlaybooksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListPlaybooksResponsePlaybook

A pageable asynchronous sequence of Playbook resources.
Overrides

RestorePlaybookVersion(RestorePlaybookVersionRequest, CallSettings)

public override RestorePlaybookVersionResponse RestorePlaybookVersion(RestorePlaybookVersionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RestorePlaybookVersionResponse

The RPC response.
Overrides

RestorePlaybookVersionAsync(RestorePlaybookVersionRequest, CallSettings)

public override Task<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(RestorePlaybookVersionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRestorePlaybookVersionResponse

A Task containing the RPC response.
Overrides

UpdatePlaybook(UpdatePlaybookRequest, CallSettings)

public override Playbook UpdatePlaybook(UpdatePlaybookRequest request, CallSettings callSettings = null)

Updates the specified Playbook.

Parameters
Name Description
request UpdatePlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Playbook

The RPC response.
Overrides

UpdatePlaybookAsync(UpdatePlaybookRequest, CallSettings)

public override Task<Playbook> UpdatePlaybookAsync(UpdatePlaybookRequest request, CallSettings callSettings = null)

Updates the specified Playbook.

Parameters
Name Description
request UpdatePlaybookRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlaybook

A Task containing the RPC response.
Overrides