blob: fdcf5dd59a898bac70d7ea8a72a15bfa269eff53 [file] [log] [blame]
<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="analyticshub_v1beta1.html">Analytics Hub API</a> . <a href="analyticshub_v1beta1.organizations.html">organizations</a> . <a href="analyticshub_v1beta1.organizations.locations.html">locations</a> . <a href="analyticshub_v1beta1.organizations.locations.dataExchanges.html">dataExchanges</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="#list">list(organization, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all data exchanges from projects in a given organization and location.</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="list">list(organization, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all data exchanges from projects in a given organization and location.
Args:
organization: string, Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`. (required)
pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing data exchanges in an organization and location.
&quot;dataExchanges&quot;: [ # The list of data exchanges.
{ # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
&quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&amp;) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
&quot;documentation&quot;: &quot;A String&quot;, # Optional. Documentation describing the data exchange.
&quot;icon&quot;: &quot;A String&quot;, # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
&quot;listingCount&quot;: 42, # Output only. Number of listings contained in the data exchange.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
&quot;primaryContact&quot;: &quot;A String&quot;, # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token to request the next page of results.
}</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>