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

Successful response

Name	Datatype	Description
name	string	Name of the tool.
description	string	Description of the tool.
inputSchema	object	JSON schema for the input parameters of the tool. (id: JsonSchema)
outputSchema	object	JSON schema for the output of the tool. (id: JsonSchema)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, connectionsId	pageSize, pageToken	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
pageSize	integer (int32)
pageToken	string

SELECT examples

list

Lists all available tools.

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

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 }}"
}';