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
check_status	exec	projectsId, locationsId, connectionsId		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).
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).
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'.

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

Lifecycle Methods

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;

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=
'{
"authCodeData": "{{ authCodeData }}"
}';

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=
'{
"refreshToken": "{{ refreshToken }}"
}';

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