tools

Creates, updates, deletes, gets or lists a tools resource.

Overview

Name	tools
Type	Resource
Id	google.connectors.tools

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Name of the tool.
_meta	object	Metadata for the tool.
annotations	object	Annotations for the tool. (id: ToolAnnotations)
dependsOn	array	List of tool names that this tool depends on.
description	string	Description of the tool.
inputSchema	object	JsonSchema representation of schema metadata (id: JsonSchema)
outputSchema	object	JsonSchema representation of schema metadata (id: JsonSchema)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, connectionsId	pageToken, toolNames, executionConfig.headers, pageSize	Lists all available tools.
execute	exec	projectsId, locationsId, connectionsId, toolsId		Executes a specific tool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connectionsId	string
locationsId	string
projectsId	string
toolsId	string
executionConfig.headers	string
pageSize	integer (int32)
pageToken	string
toolNames	string

SELECT examples

list

Lists all available tools.

SELECT
name,
_meta,
annotations,
dependsOn,
description,
inputSchema,
outputSchema
FROM google.connectors.tools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionsId = '{{ connectionsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND toolNames = '{{ toolNames }}'
AND executionConfig.headers = '{{ executionConfig.headers }}'
AND pageSize = '{{ pageSize }}'
;

Lifecycle Methods

execute

Executes a specific tool.

EXEC google.connectors.tools.execute 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required, 
@toolsId='{{ toolsId }}' --required 
@@json=
'{
"parameters": "{{ parameters }}", 
"executionConfig": "{{ executionConfig }}", 
"toolDefinition": "{{ toolDefinition }}"
}'
;