Dialogflow v3 API - Class ToolsClient (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

public abstract class ToolsClient

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

Tools client wrapper, for convenient use.

Inheritance

object > ToolsClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

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].

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Tools service, which is a host of "dialogflow.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Tools scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default Tools scopes are:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/dialogflow

GrpcClient

public virtual Tools.ToolsClient GrpcClient { get; }

The underlying gRPC Tools client

Property Value
Type	Description
ToolsToolsClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static ToolsClient Create()

Synchronously creates a ToolsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ToolsClientBuilder.

Returns
Type	Description
ToolsClient	The created ToolsClient.

CreateAsync(CancellationToken)

public static Task<ToolsClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ToolsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ToolsClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskToolsClient	The task representing the created ToolsClient.

CreateTool(AgentName, Tool, CallSettings)

public virtual Tool CreateTool(AgentName parent, Tool tool, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	AgentName Required. The agent to create a Tool for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
tool	Tool Required. The Tool to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Tool	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Tool tool = new Tool();
// Make the request
Tool response = toolsClient.CreateTool(parent, tool);

CreateTool(CreateToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
CreateToolRequest request = new CreateToolRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Tool = new Tool(),
};
// Make the request
Tool response = toolsClient.CreateTool(request);

CreateTool(string, Tool, CallSettings)

public virtual Tool CreateTool(string parent, Tool tool, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The agent to create a Tool for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
tool	Tool Required. The Tool to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Tool	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Tool tool = new Tool();
// Make the request
Tool response = toolsClient.CreateTool(parent, tool);

CreateToolAsync(AgentName, Tool, CallSettings)

public virtual Task<Tool> CreateToolAsync(AgentName parent, Tool tool, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	AgentName Required. The agent to create a Tool for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
tool	Tool Required. The Tool to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Tool tool = new Tool();
// Make the request
Tool response = await toolsClient.CreateToolAsync(parent, tool);

CreateToolAsync(AgentName, Tool, CancellationToken)

public virtual Task<Tool> CreateToolAsync(AgentName parent, Tool tool, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	AgentName Required. The agent to create a Tool for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
tool	Tool Required. The Tool to be created.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Tool tool = new Tool();
// Make the request
Tool response = await toolsClient.CreateToolAsync(parent, tool);

CreateToolAsync(CreateToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
CreateToolRequest request = new CreateToolRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Tool = new Tool(),
};
// Make the request
Tool response = await toolsClient.CreateToolAsync(request);

CreateToolAsync(CreateToolRequest, CancellationToken)

public virtual Task<Tool> CreateToolAsync(CreateToolRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
CreateToolRequest request = new CreateToolRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Tool = new Tool(),
};
// Make the request
Tool response = await toolsClient.CreateToolAsync(request);

CreateToolAsync(string, Tool, CallSettings)

public virtual Task<Tool> CreateToolAsync(string parent, Tool tool, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The agent to create a Tool for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
tool	Tool Required. The Tool to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Tool tool = new Tool();
// Make the request
Tool response = await toolsClient.CreateToolAsync(parent, tool);

CreateToolAsync(string, Tool, CancellationToken)

public virtual Task<Tool> CreateToolAsync(string parent, Tool tool, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	string Required. The agent to create a Tool for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
tool	Tool Required. The Tool to be created.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Tool tool = new Tool();
// Make the request
Tool response = await toolsClient.CreateToolAsync(parent, tool);

CreateToolVersion(CreateToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
CreateToolVersionRequest request = new CreateToolVersionRequest
{
    ParentAsToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
    ToolVersion = new ToolVersion(),
};
// Make the request
ToolVersion response = toolsClient.CreateToolVersion(request);

CreateToolVersion(ToolName, ToolVersion, CallSettings)

public virtual ToolVersion CreateToolVersion(ToolName parent, ToolVersion toolVersion, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	ToolName Required. The tool to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
toolVersion	ToolVersion Required. The tool version to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ToolVersion	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ToolName parent = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
ToolVersion toolVersion = new ToolVersion();
// Make the request
ToolVersion response = toolsClient.CreateToolVersion(parent, toolVersion);

CreateToolVersion(string, ToolVersion, CallSettings)

public virtual ToolVersion CreateToolVersion(string parent, ToolVersion toolVersion, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The tool to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
toolVersion	ToolVersion Required. The tool version to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ToolVersion	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
ToolVersion toolVersion = new ToolVersion();
// Make the request
ToolVersion response = toolsClient.CreateToolVersion(parent, toolVersion);

CreateToolVersionAsync(CreateToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
CreateToolVersionRequest request = new CreateToolVersionRequest
{
    ParentAsToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
    ToolVersion = new ToolVersion(),
};
// Make the request
ToolVersion response = await toolsClient.CreateToolVersionAsync(request);

CreateToolVersionAsync(CreateToolVersionRequest, CancellationToken)

public virtual Task<ToolVersion> CreateToolVersionAsync(CreateToolVersionRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
CreateToolVersionRequest request = new CreateToolVersionRequest
{
    ParentAsToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
    ToolVersion = new ToolVersion(),
};
// Make the request
ToolVersion response = await toolsClient.CreateToolVersionAsync(request);

CreateToolVersionAsync(ToolName, ToolVersion, CallSettings)

public virtual Task<ToolVersion> CreateToolVersionAsync(ToolName parent, ToolVersion toolVersion, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	ToolName Required. The tool to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
toolVersion	ToolVersion Required. The tool version to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolName parent = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
ToolVersion toolVersion = new ToolVersion();
// Make the request
ToolVersion response = await toolsClient.CreateToolVersionAsync(parent, toolVersion);

CreateToolVersionAsync(ToolName, ToolVersion, CancellationToken)

public virtual Task<ToolVersion> CreateToolVersionAsync(ToolName parent, ToolVersion toolVersion, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	ToolName Required. The tool to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
toolVersion	ToolVersion Required. The tool version to create.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolName parent = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
ToolVersion toolVersion = new ToolVersion();
// Make the request
ToolVersion response = await toolsClient.CreateToolVersionAsync(parent, toolVersion);

CreateToolVersionAsync(string, ToolVersion, CallSettings)

public virtual Task<ToolVersion> CreateToolVersionAsync(string parent, ToolVersion toolVersion, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The tool to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
toolVersion	ToolVersion Required. The tool version to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
ToolVersion toolVersion = new ToolVersion();
// Make the request
ToolVersion response = await toolsClient.CreateToolVersionAsync(parent, toolVersion);

CreateToolVersionAsync(string, ToolVersion, CancellationToken)

public virtual Task<ToolVersion> CreateToolVersionAsync(string parent, ToolVersion toolVersion, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	string Required. The tool to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
toolVersion	ToolVersion Required. The tool version to create.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
ToolVersion toolVersion = new ToolVersion();
// Make the request
ToolVersion response = await toolsClient.CreateToolVersionAsync(parent, toolVersion);

DeleteTool(DeleteToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
DeleteToolRequest request = new DeleteToolRequest
{
    ToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
    Force = false,
};
// Make the request
toolsClient.DeleteTool(request);

DeleteTool(ToolName, CallSettings)

public virtual void DeleteTool(ToolName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolName Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ToolName name = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
toolsClient.DeleteTool(name);

DeleteTool(string, CallSettings)

public virtual void DeleteTool(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
toolsClient.DeleteTool(name);

DeleteToolAsync(DeleteToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
DeleteToolRequest request = new DeleteToolRequest
{
    ToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
    Force = false,
};
// Make the request
await toolsClient.DeleteToolAsync(request);

DeleteToolAsync(DeleteToolRequest, CancellationToken)

public virtual Task DeleteToolAsync(DeleteToolRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
DeleteToolRequest request = new DeleteToolRequest
{
    ToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
    Force = false,
};
// Make the request
await toolsClient.DeleteToolAsync(request);

DeleteToolAsync(ToolName, CallSettings)

public virtual Task DeleteToolAsync(ToolName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolName Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolName name = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
await toolsClient.DeleteToolAsync(name);

DeleteToolAsync(ToolName, CancellationToken)

public virtual Task DeleteToolAsync(ToolName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	ToolName Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolName name = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
await toolsClient.DeleteToolAsync(name);

DeleteToolAsync(string, CallSettings)

public virtual Task DeleteToolAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
await toolsClient.DeleteToolAsync(name);

DeleteToolAsync(string, CancellationToken)

public virtual Task DeleteToolAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. The name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
await toolsClient.DeleteToolAsync(name);

DeleteToolVersion(DeleteToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
DeleteToolVersionRequest request = new DeleteToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
    Force = false,
};
// Make the request
toolsClient.DeleteToolVersion(request);

DeleteToolVersion(ToolVersionName, CallSettings)

public virtual void DeleteToolVersion(ToolVersionName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolVersionName Required. The name of the tool version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
toolsClient.DeleteToolVersion(name);

DeleteToolVersion(string, CallSettings)

public virtual void DeleteToolVersion(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the tool version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
toolsClient.DeleteToolVersion(name);

DeleteToolVersionAsync(DeleteToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
DeleteToolVersionRequest request = new DeleteToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
    Force = false,
};
// Make the request
await toolsClient.DeleteToolVersionAsync(request);

DeleteToolVersionAsync(DeleteToolVersionRequest, CancellationToken)

public virtual Task DeleteToolVersionAsync(DeleteToolVersionRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
DeleteToolVersionRequest request = new DeleteToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
    Force = false,
};
// Make the request
await toolsClient.DeleteToolVersionAsync(request);

DeleteToolVersionAsync(ToolVersionName, CallSettings)

public virtual Task DeleteToolVersionAsync(ToolVersionName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolVersionName Required. The name of the tool version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
await toolsClient.DeleteToolVersionAsync(name);

DeleteToolVersionAsync(ToolVersionName, CancellationToken)

public virtual Task DeleteToolVersionAsync(ToolVersionName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	ToolVersionName Required. The name of the tool version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
await toolsClient.DeleteToolVersionAsync(name);

DeleteToolVersionAsync(string, CallSettings)

public virtual Task DeleteToolVersionAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the tool version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
await toolsClient.DeleteToolVersionAsync(name);

DeleteToolVersionAsync(string, CancellationToken)

public virtual Task DeleteToolVersionAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. The name of the tool version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
await toolsClient.DeleteToolVersionAsync(name);

GetTool(GetToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
GetToolRequest request = new GetToolRequest
{
    ToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
};
// Make the request
Tool response = toolsClient.GetTool(request);

GetTool(ToolName, CallSettings)

public virtual Tool GetTool(ToolName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolName Required. The name of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Tool	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ToolName name = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
Tool response = toolsClient.GetTool(name);

GetTool(string, CallSettings)

public virtual Tool GetTool(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Tool	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
Tool response = toolsClient.GetTool(name);

GetToolAsync(GetToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
GetToolRequest request = new GetToolRequest
{
    ToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
};
// Make the request
Tool response = await toolsClient.GetToolAsync(request);

GetToolAsync(GetToolRequest, CancellationToken)

public virtual Task<Tool> GetToolAsync(GetToolRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
GetToolRequest request = new GetToolRequest
{
    ToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
};
// Make the request
Tool response = await toolsClient.GetToolAsync(request);

GetToolAsync(ToolName, CallSettings)

public virtual Task<Tool> GetToolAsync(ToolName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolName Required. The name of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolName name = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
Tool response = await toolsClient.GetToolAsync(name);

GetToolAsync(ToolName, CancellationToken)

public virtual Task<Tool> GetToolAsync(ToolName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	ToolName Required. The name of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolName name = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
Tool response = await toolsClient.GetToolAsync(name);

GetToolAsync(string, CallSettings)

public virtual Task<Tool> GetToolAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
Tool response = await toolsClient.GetToolAsync(name);

GetToolAsync(string, CancellationToken)

public virtual Task<Tool> GetToolAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. The name of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
Tool response = await toolsClient.GetToolAsync(name);

GetToolVersion(GetToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
GetToolVersionRequest request = new GetToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
};
// Make the request
ToolVersion response = toolsClient.GetToolVersion(request);

GetToolVersion(ToolVersionName, CallSettings)

public virtual ToolVersion GetToolVersion(ToolVersionName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolVersionName Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ToolVersion	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
ToolVersion response = toolsClient.GetToolVersion(name);

GetToolVersion(string, CallSettings)

public virtual ToolVersion GetToolVersion(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ToolVersion	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
ToolVersion response = toolsClient.GetToolVersion(name);

GetToolVersionAsync(GetToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
GetToolVersionRequest request = new GetToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
};
// Make the request
ToolVersion response = await toolsClient.GetToolVersionAsync(request);

GetToolVersionAsync(GetToolVersionRequest, CancellationToken)

public virtual Task<ToolVersion> GetToolVersionAsync(GetToolVersionRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
GetToolVersionRequest request = new GetToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
};
// Make the request
ToolVersion response = await toolsClient.GetToolVersionAsync(request);

GetToolVersionAsync(ToolVersionName, CallSettings)

public virtual Task<ToolVersion> GetToolVersionAsync(ToolVersionName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ToolVersionName Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
ToolVersion response = await toolsClient.GetToolVersionAsync(name);

GetToolVersionAsync(ToolVersionName, CancellationToken)

public virtual Task<ToolVersion> GetToolVersionAsync(ToolVersionName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	ToolVersionName Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
ToolVersion response = await toolsClient.GetToolVersionAsync(name);

GetToolVersionAsync(string, CallSettings)

public virtual Task<ToolVersion> GetToolVersionAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	string Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
ToolVersion response = await toolsClient.GetToolVersionAsync(name);

GetToolVersionAsync(string, CancellationToken)

public virtual Task<ToolVersion> GetToolVersionAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskToolVersion	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
ToolVersion response = await toolsClient.GetToolVersionAsync(name);

ListToolVersions(ListToolVersionsRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ListToolVersionsRequest request = new ListToolVersionsRequest
{
    ParentAsToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
};
// Make the request
PagedEnumerable<ListToolVersionsResponse, ToolVersion> response = toolsClient.ListToolVersions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ToolVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListToolVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ToolVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ToolVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ToolVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolVersions(ToolName, string, int?, CallSettings)

public virtual PagedEnumerable<ListToolVersionsResponse, ToolVersion> ListToolVersions(ToolName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	ToolName Required. The parent of the tool versions. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListToolVersionsResponseToolVersion	A pageable sequence of ToolVersion resources.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ToolName parent = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
PagedEnumerable<ListToolVersionsResponse, ToolVersion> response = toolsClient.ListToolVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ToolVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListToolVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ToolVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ToolVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ToolVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolVersions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListToolVersionsResponse, ToolVersion> ListToolVersions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The parent of the tool versions. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListToolVersionsResponseToolVersion	A pageable sequence of ToolVersion resources.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
PagedEnumerable<ListToolVersionsResponse, ToolVersion> response = toolsClient.ListToolVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ToolVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListToolVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ToolVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ToolVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ToolVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolVersionsAsync(ListToolVersionsRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ListToolVersionsRequest request = new ListToolVersionsRequest
{
    ParentAsToolName = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]"),
};
// Make the request
PagedAsyncEnumerable<ListToolVersionsResponse, ToolVersion> response = toolsClient.ListToolVersionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (ToolVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListToolVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ToolVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ToolVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ToolVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolVersionsAsync(ToolName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListToolVersionsResponse, ToolVersion> ListToolVersionsAsync(ToolName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	ToolName Required. The parent of the tool versions. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListToolVersionsResponseToolVersion	A pageable asynchronous sequence of ToolVersion resources.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolName parent = ToolName.FromProjectLocationAgentTool("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
// Make the request
PagedAsyncEnumerable<ListToolVersionsResponse, ToolVersion> response = toolsClient.ListToolVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (ToolVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListToolVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ToolVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ToolVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ToolVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolVersionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListToolVersionsResponse, ToolVersion> ListToolVersionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The parent of the tool versions. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListToolVersionsResponseToolVersion	A pageable asynchronous sequence of ToolVersion resources.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]";
// Make the request
PagedAsyncEnumerable<ListToolVersionsResponse, ToolVersion> response = toolsClient.ListToolVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (ToolVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListToolVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ToolVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ToolVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ToolVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTools(AgentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListToolsResponse, Tool> ListTools(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	AgentName Required. The agent to list the Tools from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListToolsResponseTool	A pageable sequence of Tool resources.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedEnumerable<ListToolsResponse, Tool> response = toolsClient.ListTools(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Tool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListToolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTools(ListToolsRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ListToolsRequest request = new ListToolsRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedEnumerable<ListToolsResponse, Tool> response = toolsClient.ListTools(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Tool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListToolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTools(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListToolsResponse, Tool> ListTools(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The agent to list the Tools from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListToolsResponseTool	A pageable sequence of Tool resources.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedEnumerable<ListToolsResponse, Tool> response = toolsClient.ListTools(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Tool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListToolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolsAsync(AgentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListToolsResponse, Tool> ListToolsAsync(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	AgentName Required. The agent to list the Tools from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListToolsResponseTool	A pageable asynchronous sequence of Tool resources.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedAsyncEnumerable<ListToolsResponse, Tool> response = toolsClient.ListToolsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Tool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListToolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolsAsync(ListToolsRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ListToolsRequest request = new ListToolsRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedAsyncEnumerable<ListToolsResponse, Tool> response = toolsClient.ListToolsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Tool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListToolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListToolsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListToolsResponse, Tool> ListToolsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The agent to list the Tools from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListToolsResponseTool	A pageable asynchronous sequence of Tool resources.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedAsyncEnumerable<ListToolsResponse, Tool> response = toolsClient.ListToolsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Tool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListToolsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

RestoreToolVersion(RestoreToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
RestoreToolVersionRequest request = new RestoreToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
};
// Make the request
RestoreToolVersionResponse response = toolsClient.RestoreToolVersion(request);

RestoreToolVersion(ToolVersionName, CallSettings)

public virtual RestoreToolVersionResponse RestoreToolVersion(ToolVersionName name, 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
name	ToolVersionName Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RestoreToolVersionResponse	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
RestoreToolVersionResponse response = toolsClient.RestoreToolVersion(name);

RestoreToolVersion(string, CallSettings)

public virtual RestoreToolVersionResponse RestoreToolVersion(string name, 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
name	string Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RestoreToolVersionResponse	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
RestoreToolVersionResponse response = toolsClient.RestoreToolVersion(name);

RestoreToolVersionAsync(RestoreToolVersionRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
RestoreToolVersionRequest request = new RestoreToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
};
// Make the request
RestoreToolVersionResponse response = await toolsClient.RestoreToolVersionAsync(request);

RestoreToolVersionAsync(RestoreToolVersionRequest, CancellationToken)

public virtual Task<RestoreToolVersionResponse> RestoreToolVersionAsync(RestoreToolVersionRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskRestoreToolVersionResponse	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
RestoreToolVersionRequest request = new RestoreToolVersionRequest
{
    ToolVersionName = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]"),
};
// Make the request
RestoreToolVersionResponse response = await toolsClient.RestoreToolVersionAsync(request);

RestoreToolVersionAsync(ToolVersionName, CallSettings)

public virtual Task<RestoreToolVersionResponse> RestoreToolVersionAsync(ToolVersionName name, 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
name	ToolVersionName Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRestoreToolVersionResponse	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
RestoreToolVersionResponse response = await toolsClient.RestoreToolVersionAsync(name);

RestoreToolVersionAsync(ToolVersionName, CancellationToken)

public virtual Task<RestoreToolVersionResponse> RestoreToolVersionAsync(ToolVersionName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	ToolVersionName Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskRestoreToolVersionResponse	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
ToolVersionName name = ToolVersionName.FromProjectLocationAgentToolVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]", "[VERSION]");
// Make the request
RestoreToolVersionResponse response = await toolsClient.RestoreToolVersionAsync(name);

RestoreToolVersionAsync(string, CallSettings)

public virtual Task<RestoreToolVersionResponse> RestoreToolVersionAsync(string name, 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
name	string Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRestoreToolVersionResponse	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
RestoreToolVersionResponse response = await toolsClient.RestoreToolVersionAsync(name);

RestoreToolVersionAsync(string, CancellationToken)

public virtual Task<RestoreToolVersionResponse> RestoreToolVersionAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. The name of the tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskRestoreToolVersionResponse	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/tools/[TOOL]/versions/[VERSION]";
// Make the request
RestoreToolVersionResponse response = await toolsClient.RestoreToolVersionAsync(name);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateTool(Tool, FieldMask, CallSettings)

public virtual Tool UpdateTool(Tool tool, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name	Description
tool	Tool Required. The Tool to be updated.
updateMask	FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Tool	The RPC response.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
Tool tool = new Tool();
FieldMask updateMask = new FieldMask();
// Make the request
Tool response = toolsClient.UpdateTool(tool, updateMask);

UpdateTool(UpdateToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = ToolsClient.Create();
// Initialize request argument(s)
UpdateToolRequest request = new UpdateToolRequest
{
    Tool = new Tool(),
    UpdateMask = new FieldMask(),
};
// Make the request
Tool response = toolsClient.UpdateTool(request);

UpdateToolAsync(Tool, FieldMask, CallSettings)

public virtual Task<Tool> UpdateToolAsync(Tool tool, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name	Description
tool	Tool Required. The Tool to be updated.
updateMask	FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
Tool tool = new Tool();
FieldMask updateMask = new FieldMask();
// Make the request
Tool response = await toolsClient.UpdateToolAsync(tool, updateMask);

UpdateToolAsync(Tool, FieldMask, CancellationToken)

public virtual Task<Tool> UpdateToolAsync(Tool tool, FieldMask updateMask, CancellationToken cancellationToken)

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

Parameters
Name	Description
tool	Tool Required. The Tool to be updated.
updateMask	FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
Tool tool = new Tool();
FieldMask updateMask = new FieldMask();
// Make the request
Tool response = await toolsClient.UpdateToolAsync(tool, updateMask);

UpdateToolAsync(UpdateToolRequest, CallSettings)

public virtual 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.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
UpdateToolRequest request = new UpdateToolRequest
{
    Tool = new Tool(),
    UpdateMask = new FieldMask(),
};
// Make the request
Tool response = await toolsClient.UpdateToolAsync(request);

UpdateToolAsync(UpdateToolRequest, CancellationToken)

public virtual Task<Tool> UpdateToolAsync(UpdateToolRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTool	A Task containing the RPC response.

Example

// Create client
ToolsClient toolsClient = await ToolsClient.CreateAsync();
// Initialize request argument(s)
UpdateToolRequest request = new UpdateToolRequest
{
    Tool = new Tool(),
    UpdateMask = new FieldMask(),
};
// Make the request
Tool response = await toolsClient.UpdateToolAsync(request);