class ProjectsLocationsConnections extends Resource (View source)

The "connections" collection of methods.

Typical usage is:

 $connectorsService = new Google\Service\Connectors(...);
 $connections = $connectorsService->projects_locations_connections;

Methods

checkReadiness(string $name, array $optParams = [])

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

checkStatus(string $name, array $optParams = [])

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. (connections.checkStatus)

exchangeAuthCode(string $name, ExchangeAuthCodeRequest $postBody, array $optParams = [])

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

executeSqlQuery(string $connection, ExecuteSqlQueryRequest $postBody, array $optParams = [])

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'.

refreshAccessToken(string $name, RefreshAccessTokenRequest $postBody, array $optParams = [])

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

Details

CheckReadinessResponse checkReadiness(string $name, array $optParams = [])

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

(connections.checkReadiness)

Parameters

string $name
array $optParams

Optional parameters.

Return Value

CheckReadinessResponse

Exceptions

Exception

CheckStatusResponse checkStatus(string $name, array $optParams = [])

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. (connections.checkStatus)

Parameters

string $name
array $optParams

Optional parameters.

Return Value

CheckStatusResponse

Exceptions

Exception

ExchangeAuthCodeResponse exchangeAuthCode(string $name, ExchangeAuthCodeRequest $postBody, array $optParams = [])

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

(connections.exchangeAuthCode)

Parameters

string $name
ExchangeAuthCodeRequest $postBody
array $optParams

Optional parameters.

Return Value

ExchangeAuthCodeResponse

Exceptions

Exception

ExecuteSqlQueryResponse executeSqlQuery(string $connection, ExecuteSqlQueryRequest $postBody, array $optParams = [])

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'.

(connections.executeSqlQuery)

Parameters

string $connection

Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}

ExecuteSqlQueryRequest $postBody
array $optParams

Optional parameters.

Return Value

ExecuteSqlQueryResponse

Exceptions

Exception

RefreshAccessTokenResponse refreshAccessToken(string $name, RefreshAccessTokenRequest $postBody, array $optParams = [])

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

(connections.refreshAccessToken)

Parameters

string $name
RefreshAccessTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

RefreshAccessTokenResponse

Exceptions

Exception