Dialogflow v3 API - Class ToolsClientImpl (3.0.0) 

public sealed class ToolsClientImpl : ToolsClient

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

Tools client wrapper implementation, for convenient use.

Inheritance

object > ToolsClient > ToolsClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Tools][google.cloud.dialogflow.cx.v3.Tool].

Constructors

ToolsClientImpl(ToolsClient, ToolsSettings, ILogger)

public ToolsClientImpl(Tools.ToolsClient grpcClient, ToolsSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient ToolsToolsClient

The underlying gRPC client.
settings ToolsSettings

The base ToolsSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Tools.ToolsClient GrpcClient { get; }

The underlying gRPC Tools client

Property Value
Type Description
ToolsToolsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CreateTool(CreateToolRequest, CallSettings)

public override Tool CreateTool(CreateToolRequest request, CallSettings callSettings = null)

Creates a [Tool][google.cloud.dialogflow.cx.v3.Tool] in the specified agent.

Parameters
Name Description
request CreateToolRequest

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
Tool

The RPC response.
Overrides

CreateToolAsync(CreateToolRequest, CallSettings)

public override Task<Tool> CreateToolAsync(CreateToolRequest request, CallSettings callSettings = null)

Creates a [Tool][google.cloud.dialogflow.cx.v3.Tool] in the specified agent.

Parameters
Name Description
request CreateToolRequest

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
TaskTool

A Task containing the RPC response.
Overrides

CreateToolVersion(CreateToolVersionRequest, CallSettings)

public override ToolVersion CreateToolVersion(CreateToolVersionRequest request, CallSettings callSettings = null)

Creates a version for the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request CreateToolVersionRequest

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
ToolVersion

The RPC response.
Overrides

CreateToolVersionAsync(CreateToolVersionRequest, CallSettings)

public override Task<ToolVersion> CreateToolVersionAsync(CreateToolVersionRequest request, CallSettings callSettings = null)

Creates a version for the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request CreateToolVersionRequest

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
TaskToolVersion

A Task containing the RPC response.
Overrides

DeleteTool(DeleteToolRequest, CallSettings)

public override void DeleteTool(DeleteToolRequest request, CallSettings callSettings = null)

Deletes a specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request DeleteToolRequest

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

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

DeleteToolAsync(DeleteToolRequest, CallSettings)

public override Task DeleteToolAsync(DeleteToolRequest request, CallSettings callSettings = null)

Deletes a specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request DeleteToolRequest

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

DeleteToolVersion(DeleteToolVersionRequest, CallSettings)

public override void DeleteToolVersion(DeleteToolVersionRequest request, CallSettings callSettings = null)

Deletes the specified version of the [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request DeleteToolVersionRequest

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

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

DeleteToolVersionAsync(DeleteToolVersionRequest, CallSettings)

public override Task DeleteToolVersionAsync(DeleteToolVersionRequest request, CallSettings callSettings = null)

Deletes the specified version of the [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request DeleteToolVersionRequest

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

GetTool(GetToolRequest, CallSettings)

public override Tool GetTool(GetToolRequest request, CallSettings callSettings = null)

Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request GetToolRequest

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
Tool

The RPC response.
Overrides

GetToolAsync(GetToolRequest, CallSettings)

public override Task<Tool> GetToolAsync(GetToolRequest request, CallSettings callSettings = null)

Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request GetToolRequest

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
TaskTool

A Task containing the RPC response.
Overrides

GetToolVersion(GetToolVersionRequest, CallSettings)

public override ToolVersion GetToolVersion(GetToolVersionRequest request, CallSettings callSettings = null)

Retrieves the specified version of the [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request GetToolVersionRequest

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
ToolVersion

The RPC response.
Overrides

GetToolVersionAsync(GetToolVersionRequest, CallSettings)

public override Task<ToolVersion> GetToolVersionAsync(GetToolVersionRequest request, CallSettings callSettings = null)

Retrieves the specified version of the [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request GetToolVersionRequest

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
TaskToolVersion

A Task containing the RPC response.
Overrides

ListToolVersions(ListToolVersionsRequest, CallSettings)

public override PagedEnumerable<ListToolVersionsResponse, ToolVersion> ListToolVersions(ListToolVersionsRequest request, CallSettings callSettings = null)

List versions of the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request ListToolVersionsRequest

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
PagedEnumerableListToolVersionsResponseToolVersion

A pageable sequence of ToolVersion resources.
Overrides

ListToolVersionsAsync(ListToolVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListToolVersionsResponse, ToolVersion> ListToolVersionsAsync(ListToolVersionsRequest request, CallSettings callSettings = null)

List versions of the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request ListToolVersionsRequest

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
PagedAsyncEnumerableListToolVersionsResponseToolVersion

A pageable asynchronous sequence of ToolVersion resources.
Overrides

ListTools(ListToolsRequest, CallSettings)

public override PagedEnumerable<ListToolsResponse, Tool> ListTools(ListToolsRequest request, CallSettings callSettings = null)

Returns a list of [Tools][google.cloud.dialogflow.cx.v3.Tool] in the specified agent.

Parameters
Name Description
request ListToolsRequest

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
PagedEnumerableListToolsResponseTool

A pageable sequence of Tool resources.
Overrides

ListToolsAsync(ListToolsRequest, CallSettings)

public override PagedAsyncEnumerable<ListToolsResponse, Tool> ListToolsAsync(ListToolsRequest request, CallSettings callSettings = null)

Returns a list of [Tools][google.cloud.dialogflow.cx.v3.Tool] in the specified agent.

Parameters
Name Description
request ListToolsRequest

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
PagedAsyncEnumerableListToolsResponseTool

A pageable asynchronous sequence of Tool resources.
Overrides

RestoreToolVersion(RestoreToolVersionRequest, CallSettings)

public override RestoreToolVersionResponse RestoreToolVersion(RestoreToolVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request RestoreToolVersionRequest

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
RestoreToolVersionResponse

The RPC response.
Overrides

RestoreToolVersionAsync(RestoreToolVersionRequest, CallSettings)

public override Task<RestoreToolVersionResponse> RestoreToolVersionAsync(RestoreToolVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request RestoreToolVersionRequest

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
TaskRestoreToolVersionResponse

A Task containing the RPC response.
Overrides

UpdateTool(UpdateToolRequest, CallSettings)

public override Tool UpdateTool(UpdateToolRequest request, CallSettings callSettings = null)

Update the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request UpdateToolRequest

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
Tool

The RPC response.
Overrides

UpdateToolAsync(UpdateToolRequest, CallSettings)

public override Task<Tool> UpdateToolAsync(UpdateToolRequest request, CallSettings callSettings = null)

Update the specified [Tool][google.cloud.dialogflow.cx.v3.Tool].

Parameters
Name Description
request UpdateToolRequest

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
TaskTool

A Task containing the RPC response.
Overrides