blob: e47af6c36ee65bb17ee034355da8065d6506c99d [file] [edit]
<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> . <a href="connectors_v2.projects.locations.connections.resources.html">resources</a></h1>
<h2>Instance Methods</h2>
<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="#get">get(name, executionConfig_headers=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a specific resource.</p>
<p class="toc_element">
<code><a href="#getResourcePost">getResourcePost(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a specific resource with POST.</p>
<p class="toc_element">
<code><a href="#list">list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all available resources.</p>
<p class="toc_element">
<code><a href="#list_next">list_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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, executionConfig_headers=None, x__xgafv=None)</code>
<pre>Gets a specific resource.
Args:
name: string, Required. Resource name of the Resource. Format: projects/{project}/locations/{location}/connections/{connection}/resources/{resource} (required)
executionConfig_headers: string, headers to be used for the request. For example: headers:&#x27;{&quot;x-integration-connectors-managed-connection-id&quot;:&quot;conn-id&quot;,&quot;x-integration-connectors-runtime-config&quot;:&quot;runtime-cfg&quot;}&#x27;
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;_meta&quot;: { # Metadata for the resource.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;data&quot;: &quot;A String&quot;, # The content of the resource.
&quot;metadata&quot;: { # Metadata like service latency, etc.
&quot;a_key&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
&quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="getResourcePost">getResourcePost(name, body=None, x__xgafv=None)</code>
<pre>Gets a specific resource with POST.
Args:
name: string, Required. Resource name of the Resource. Format: projects/{project}/locations/{location}/connections/{connection}/resources/{resource} (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ConnectorAgentService.GetResourcePost
&quot;executionConfig&quot;: { # execution config for the request.
&quot;headers&quot;: &quot;A String&quot;, # headers to be used for the request. For example: headers:&#x27;{&quot;x-integration-connectors-managed-connection-id&quot;:&quot;conn-id&quot;,&quot;x-integration-connectors-runtime-config&quot;:&quot;runtime-cfg&quot;}&#x27;
},
&quot;toolSpec&quot;: { # List of tool specifications.
&quot;toolDefinitions&quot;: [ # List of tool definitions.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
],
&quot;toolSpecVersion&quot;: &quot;A String&quot;, # Version of the tool spec. Format: providerId/connectorId/versionId/toolSpecId
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;_meta&quot;: { # Metadata for the resource.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;data&quot;: &quot;A String&quot;, # The content of the resource.
&quot;metadata&quot;: { # Metadata like service latency, etc.
&quot;a_key&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
&quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all available resources.
Args:
parent: string, Required. Resource name of the connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
executionConfig_headers: string, headers to be used for the request. For example: headers:&#x27;{&quot;x-integration-connectors-managed-connection-id&quot;:&quot;conn-id&quot;,&quot;x-integration-connectors-runtime-config&quot;:&quot;runtime-cfg&quot;}&#x27;
pageSize: integer, Optional. Page size for the request.
pageToken: string, Optional. Page token for the request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;metadata&quot;: { # Metadata like service latency, etc.
&quot;a_key&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
&quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token if more resources available.
&quot;resources&quot;: [ # List of available resources.
{
&quot;_meta&quot;: { # Metadata for the resource.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;description&quot;: &quot;A String&quot;, # A description of what this resource represents.
&quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of this resource, if known.
&quot;name&quot;: &quot;A String&quot;, # A human-readable name for this resource.
&quot;size&quot;: &quot;A String&quot;, # The size of the raw resource content, in bytes, if known.
&quot;uri&quot;: &quot;A String&quot;, # The URI of this resource.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>