Skip to main content

connections

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

Overview

Nameconnections
TypeResource
Idgoogle.connectors.connections

Fields

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

Methods

NameAccessible byRequired ParamsDescription
check_readinessEXECconnectionsId, locationsId, projectsIdReports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.
check_statusEXECconnectionsId, locationsId, projectsIdReports 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.
exchange_auth_codeEXECconnectionsId, locationsId, projectsIdExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).
execute_sql_queryEXECconnectionsId, locationsId, projectsIdExecutes 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'.
refresh_access_tokenEXECconnectionsId, locationsId, projectsIdRefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).