Gemini Enterprise for Customer Experience v1 API - Class ToolService.ToolServiceClient (1.0.0-beta01)

public class ToolService.ToolServiceClient : ClientBase<ToolService.ToolServiceClient>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class ToolService.ToolServiceClient.

Client for ToolService

Inheritance

object > ClientBase > ClientBaseToolServiceToolServiceClient > ToolService.ToolServiceClient

Inherited Members

ClientBase<ToolService.ToolServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

ToolServiceClient()

protected ToolServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ToolServiceClient(CallInvoker)

public ToolServiceClient(CallInvoker callInvoker)

Creates a new client for ToolService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ToolServiceClient(ChannelBase)

public ToolServiceClient(ChannelBase channel)

Creates a new client for ToolService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ToolServiceClient(ClientBaseConfiguration)

protected ToolServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

ExecuteTool(ExecuteToolRequest, CallOptions)

public virtual ExecuteToolResponse ExecuteTool(ExecuteToolRequest request, CallOptions options)

Executes the given tool with the given arguments.

Parameters
Name	Description
request	ExecuteToolRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ExecuteToolResponse	The response received from the server.

ExecuteTool(ExecuteToolRequest, Metadata, DateTime?, CancellationToken)

public virtual ExecuteToolResponse ExecuteTool(ExecuteToolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Executes the given tool with the given arguments.

Parameters
Name	Description
request	ExecuteToolRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ExecuteToolResponse	The response received from the server.

ExecuteToolAsync(ExecuteToolRequest, CallOptions)

public virtual AsyncUnaryCall<ExecuteToolResponse> ExecuteToolAsync(ExecuteToolRequest request, CallOptions options)

Executes the given tool with the given arguments.

Parameters
Name	Description
request	ExecuteToolRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallExecuteToolResponse	The call object.

ExecuteToolAsync(ExecuteToolRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ExecuteToolResponse> ExecuteToolAsync(ExecuteToolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Executes the given tool with the given arguments.

Parameters
Name	Description
request	ExecuteToolRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallExecuteToolResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override ToolService.ToolServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ToolServiceToolServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Ces.V1.ToolService.ToolServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RetrieveToolSchema(RetrieveToolSchemaRequest, CallOptions)

public virtual RetrieveToolSchemaResponse RetrieveToolSchema(RetrieveToolSchemaRequest request, CallOptions options)

Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

Parameters
Name	Description
request	RetrieveToolSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RetrieveToolSchemaResponse	The response received from the server.

RetrieveToolSchema(RetrieveToolSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveToolSchemaResponse RetrieveToolSchema(RetrieveToolSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

Parameters
Name	Description
request	RetrieveToolSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RetrieveToolSchemaResponse	The response received from the server.

RetrieveToolSchemaAsync(RetrieveToolSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveToolSchemaResponse> RetrieveToolSchemaAsync(RetrieveToolSchemaRequest request, CallOptions options)

Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

Parameters
Name	Description
request	RetrieveToolSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRetrieveToolSchemaResponse	The call object.

RetrieveToolSchemaAsync(RetrieveToolSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveToolSchemaResponse> RetrieveToolSchemaAsync(RetrieveToolSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

Parameters
Name	Description
request	RetrieveToolSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRetrieveToolSchemaResponse	The call object.

RetrieveTools(RetrieveToolsRequest, CallOptions)

public virtual RetrieveToolsResponse RetrieveTools(RetrieveToolsRequest request, CallOptions options)

Retrieve the list of tools included in the specified toolset.

Parameters
Name	Description
request	RetrieveToolsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RetrieveToolsResponse	The response received from the server.

RetrieveTools(RetrieveToolsRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveToolsResponse RetrieveTools(RetrieveToolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the list of tools included in the specified toolset.

Parameters
Name	Description
request	RetrieveToolsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RetrieveToolsResponse	The response received from the server.

RetrieveToolsAsync(RetrieveToolsRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveToolsResponse> RetrieveToolsAsync(RetrieveToolsRequest request, CallOptions options)

Retrieve the list of tools included in the specified toolset.

Parameters
Name	Description
request	RetrieveToolsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRetrieveToolsResponse	The call object.

RetrieveToolsAsync(RetrieveToolsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveToolsResponse> RetrieveToolsAsync(RetrieveToolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the list of tools included in the specified toolset.

Parameters
Name	Description
request	RetrieveToolsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRetrieveToolsResponse	The call object.