connections

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

Overview

Name	connections
Type	Resource
Id	google.connectors.connections

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
tools	exec	projectsId, locationsId, connectionsId		Lists all available tools with POST.
generate_connection_toolspec_override	exec	projectsId, locationsId, connectionsId		Generate toolspec override for the given list of toolNames.
execute_sql_query	exec	projectsId, locationsId, connectionsId		Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.
execute_http_request	exec	projectsId, locationsId, connectionsId		Executes a generic HTTP request. This supports all payload formats including REST/JSON, GraphQL, XML, SOAP, and Multipart by passing the rendered payload as raw bytes.
refresh_access_token	exec	projectsId, locationsId, connectionsId		RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).
check_status	exec	projectsId, locationsId, connectionsId	executionConfig.headers	Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.
check_readiness	exec	projectsId, locationsId, connectionsId		Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.
exchange_auth_code	exec	projectsId, locationsId, connectionsId		ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).

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
executionConfig.headers	string

Lifecycle Methods

tools

Lists all available tools with POST.

EXEC google.connectors.connections.tools 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required 
@@json=
'{
"toolNames": "{{ toolNames }}", 
"pageSize": {{ pageSize }}, 
"pageToken": "{{ pageToken }}", 
"executionConfig": "{{ executionConfig }}", 
"toolSpec": "{{ toolSpec }}"
}'
;

generate_connection_toolspec_override

Generate toolspec override for the given list of toolNames.

EXEC google.connectors.connections.generate_connection_toolspec_override 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required 
@@json=
'{
"toolNames": "{{ toolNames }}"
}'
;

execute_sql_query

Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.

EXEC google.connectors.connections.execute_sql_query 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required 
@@json=
'{
"query": "{{ query }}"
}'
;

execute_http_request

Executes a generic HTTP request. This supports all payload formats including REST/JSON, GraphQL, XML, SOAP, and Multipart by passing the rendered payload as raw bytes.

EXEC google.connectors.connections.execute_http_request 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required 
@@json=
'{
"httpMethod": "{{ httpMethod }}", 
"url": "{{ url }}", 
"headers": "{{ headers }}", 
"rawBody": "{{ rawBody }}"
}'
;

refresh_access_token

RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).

EXEC google.connectors.connections.refresh_access_token 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required 
@@json=
'{
"executionConfig": "{{ executionConfig }}", 
"oauth2Config": "{{ oauth2Config }}", 
"refreshToken": "{{ refreshToken }}"
}'
;

check_status

Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.

EXEC google.connectors.connections.check_status 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required, 
@executionConfig.headers='{{ executionConfig.headers }}'
;

check_readiness

Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.

EXEC google.connectors.connections.check_readiness 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required
;

exchange_auth_code

ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).

EXEC google.connectors.connections.exchange_auth_code 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required 
@@json=
'{
"executionConfig": "{{ executionConfig }}", 
"oauth2Config": "{{ oauth2Config }}", 
"authCodeData": "{{ authCodeData }}"
}'
;