| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="connectors_v2.html">Connectors API</a> . <a href="connectors_v2.projects.html">projects</a> . <a href="connectors_v2.projects.locations.html">locations</a> . <a href="connectors_v2.projects.locations.connections.html">connections</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="connectors_v2.projects.locations.connections.actions.html">actions()</a></code> |
| </p> |
| <p class="firstline">Returns the actions Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="connectors_v2.projects.locations.connections.entityTypes.html">entityTypes()</a></code> |
| </p> |
| <p class="firstline">Returns the entityTypes Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="connectors_v2.projects.locations.connections.resources.html">resources()</a></code> |
| </p> |
| <p class="firstline">Returns the resources Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="connectors_v2.projects.locations.connections.tools.html">tools()</a></code> |
| </p> |
| <p class="firstline">Returns the tools Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#checkReadiness">checkReadiness(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.</p> |
| <p class="toc_element"> |
| <code><a href="#checkStatus">checkStatus(name, executionConfig_headers=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#exchangeAuthCode">exchangeAuthCode(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).</p> |
| <p class="toc_element"> |
| <code><a href="#executeHttpRequest">executeHttpRequest(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#executeSqlQuery">executeSqlQuery(connection, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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'.</p> |
| <p class="toc_element"> |
| <code><a href="#generateConnectionToolspecOverride">generateConnectionToolspecOverride(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Generate toolspec override for the given list of toolNames.</p> |
| <p class="toc_element"> |
| <code><a href="#listCustomToolNames">listCustomToolNames(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists custom tool names.</p> |
| <p class="toc_element"> |
| <code><a href="#refreshAccessToken">refreshAccessToken(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).</p> |
| <p class="toc_element"> |
| <code><a href="#tools_next">tools_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="checkReadiness">checkReadiness(name, x__xgafv=None)</code> |
| <pre>Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand. |
| |
| Args: |
| name: string, A parameter (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response containing status of the connector for readiness prober. |
| "status": "A String", |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="checkStatus">checkStatus(name, executionConfig_headers=None, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| name: string, A parameter (required) |
| executionConfig_headers: string, headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}' |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The status of the connector. |
| "description": "A String", # When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state. |
| "metadata": { # Metadata like service latency, etc. |
| "a_key": { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }, |
| "state": "A String", # State of the connector. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="exchangeAuthCode">exchangeAuthCode(name, body=None, x__xgafv=None)</code> |
| <pre>ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials). |
| |
| Args: |
| name: string, A parameter (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # ExchangeAuthCodeRequest currently includes the auth code data. |
| "authCodeData": { # AuthCodeData contains the data the runtime plane will give the connector backend in exchange for access and refresh tokens. # Optional. AuthCodeData contains the data the runtime requires to exchange for access and refresh tokens. If the data is not provided, the runtime will read the data from the secret manager. |
| "authCode": "A String", # OAuth authorization code. |
| "pkceVerifier": "A String", # OAuth PKCE verifier, needed if PKCE is enabled for this particular connection. |
| "redirectUri": "A String", # OAuth redirect URI passed in during the auth code flow, required by some OAuth backends. |
| "scopes": [ # Scopes the connection will request when the user performs the auth code flow. |
| "A String", |
| ], |
| }, |
| "executionConfig": { # ExecutionConfig contains the configuration for the execution of the request. |
| "headers": "A String", # headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}' |
| }, |
| "oauth2Config": { # OAuth2Config contains the OAuth2 config for the connection. |
| "authUri": "A String", # Authorization Server URL/Token Endpoint for Authorization Code Flow |
| "clientId": "A String", # Client ID for the OAuth2 flow. |
| "clientSecret": "A String", # Client secret for the OAuth2 flow. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # ExchangeAuthCodeResponse includes the returned access token and its associated credentials. |
| "accessCredentials": { # AccessCredentials includes the OAuth access token, and the other fields returned along with it. |
| "accessToken": "A String", # OAuth access token. |
| "expiresIn": "A String", # Duration till the access token expires. |
| "refreshToken": "A String", # OAuth refresh token. |
| }, |
| "metadata": { # Metadata like service latency, etc. |
| "a_key": { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="executeHttpRequest">executeHttpRequest(name, body=None, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| name: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "headers": [ # HTTP headers to send with the request (e.g., Content-Type: application/json). Order is preserved and duplicate keys are allowed. |
| { # A single HTTP header. Keys are case-insensitive. Multiple headers with the same key may be present. |
| "key": "A String", # The header name. |
| "value": "A String", # The header value. |
| }, |
| ], |
| "httpMethod": "A String", # Required. The HTTP method to use for the request. |
| "rawBody": "A String", # Raw byte payload. Used for all pre-serialized formats including JSON, XML, GraphQL, and Multipart. |
| "url": "A String", # Required. The fully resolved absolute target URL. Callers must pre-encode any query parameters. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "body": "A String", # The raw response body. |
| "headers": [ # HTTP headers received in the response. Order is preserved and duplicate keys are allowed (e.g., multiple Set-Cookie headers). |
| { # A single HTTP header. Keys are case-insensitive. Multiple headers with the same key may be present. |
| "key": "A String", # The header name. |
| "value": "A String", # The header value. |
| }, |
| ], |
| "reason": "A String", # The HTTP status reason phrase received from the backend (e.g., "Not Found"). May be empty if the backend did not provide one. |
| "statusCode": 42, # The HTTP status code received from the backend. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="executeSqlQuery">executeSqlQuery(connection, body=None, x__xgafv=None)</code> |
| <pre>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'. |
| |
| Args: |
| connection: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # An execute sql query request containing the query and the connection to execute it on. |
| "query": { # A wrapper around the SQL query statement. This is needed so that the JSON representation of ExecuteSqlQueryRequest has the following format: `{"query":"select *"}`. # Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems. |
| "maxRows": "A String", # Sets the limit for the maximum number of rows returned after the query execution. |
| "query": "A String", # Required. Sql query to execute. |
| "queryParameters": [ # In the struct, the value corresponds to the value of query parameter and date type corresponds to the date type of the query parameter. |
| { # Query parameter definition |
| "dataType": "A String", |
| "value": "", |
| }, |
| ], |
| "timeout": "A String", # Sets the number of seconds the driver will wait for a query to execute. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A response returned by the connection after executing the sql query. |
| "results": [ # In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the 'results' Struct list - "results": [ { "field1": "val1", "field2": "val2",.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists. |
| { |
| "a_key": "", # Properties of the object. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="generateConnectionToolspecOverride">generateConnectionToolspecOverride(name, body=None, x__xgafv=None)</code> |
| <pre>Generate toolspec override for the given list of toolNames. |
| |
| Args: |
| name: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "toolNames": [ # list of tools to be generated. |
| { |
| "entityName": "A String", # Entity name for which the tool was generated. |
| "name": "A String", # Tool name that was generated in the list tools call. |
| "operation": "A String", # Operation for which the tool was generated. |
| }, |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "toolSpec": { # tool spec that has tool_defitions array containing the tools for all sted tool_names. |
| "toolDefinitions": [ # List of tool definitions. |
| { |
| "a_key": "", # Properties of the object. |
| }, |
| ], |
| "toolSpecVersion": "A String", # Version of the tool spec. Format: providerId/connectorId/versionId/toolSpecId |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listCustomToolNames">listCustomToolNames(name, x__xgafv=None)</code> |
| <pre>Lists custom tool names. |
| |
| Args: |
| name: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "toolNames": [ # List of custom tools. |
| { |
| "entityName": "A String", # Entity name for which the tool was generated. |
| "name": "A String", # Tool name that was generated in the list tools call. |
| "operation": "A String", # Operation for which the tool was generated. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="refreshAccessToken">refreshAccessToken(name, body=None, x__xgafv=None)</code> |
| <pre>RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials). |
| |
| Args: |
| name: string, A parameter (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # RefreshAccessTokenRequest includes the refresh token. |
| "executionConfig": { # ExecutionConfig contains the configuration for the execution of the request. |
| "headers": "A String", # headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}' |
| }, |
| "oauth2Config": { # OAuth2Config contains the OAuth2 config for the connection. |
| "authUri": "A String", # Authorization Server URL/Token Endpoint for Authorization Code Flow |
| "clientId": "A String", # Client ID for the OAuth2 flow. |
| "clientSecret": "A String", # Client secret for the OAuth2 flow. |
| }, |
| "refreshToken": "A String", # Optional. Refresh Token String. If the Refresh Token is not provided, the runtime will read the data from the secret manager. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # RefreshAccessTokenResponse includes the returned access token and its associated credentials. |
| "accessCredentials": { # AccessCredentials includes the OAuth access token, and the other fields returned along with it. |
| "accessToken": "A String", # OAuth access token. |
| "expiresIn": "A String", # Duration till the access token expires. |
| "refreshToken": "A String", # OAuth refresh token. |
| }, |
| "metadata": { # Metadata like service latency, etc. |
| "a_key": { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="tools_next">tools_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
