blob: 222e30c0488788a18b42774302993b91fbacc414 [file] [log] [blame] [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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.projects.html">projects</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="#getServiceAccount">getServiceAccount(projectId, x__xgafv=None)</a></code></p>
<p class="firstline">RPC to get the service account for a project used for interactions with Google Cloud KMS</p>
<p class="toc_element">
<code><a href="#list">list(maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">RPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the [Resource Manager](https://cloud.google.com/resource-manager/docs/) API, which provides the underlying data for this method and has more capabilities.</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="getServiceAccount">getServiceAccount(projectId, x__xgafv=None)</code>
<pre>RPC to get the service account for a project used for interactions with Google Cloud KMS
Args:
projectId: string, Required. ID of the project. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response object of GetServiceAccount
&quot;email&quot;: &quot;A String&quot;, # The service account email address.
&quot;kind&quot;: &quot;bigquery#getServiceAccountResponse&quot;, # The resource type of the response.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>RPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the [Resource Manager](https://cloud.google.com/resource-manager/docs/) API, which provides the underlying data for this method and has more capabilities.
Args:
maxResults: integer, `maxResults` unset returns all results, up to 50 per page. Additionally, the number of projects in a page may be fewer than `maxResults` because projects are retrieved and then filtered to only projects with the BigQuery API enabled.
pageToken: string, Page token, returned by a previous call, to request the next page of results. If not present, no further pages are present.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response object of ListProjects
&quot;etag&quot;: &quot;A String&quot;, # A hash of the page of results.
&quot;kind&quot;: &quot;bigquery#projectList&quot;, # The resource type of the response.
&quot;nextPageToken&quot;: &quot;A String&quot;, # Use this token to request the next page of results.
&quot;projects&quot;: [ # Projects to which the user has at least READ access.
{ # Information about a single project.
&quot;friendlyName&quot;: &quot;A String&quot;, # A descriptive name for this project. A wrapper is used here because friendlyName can be set to the empty string.
&quot;id&quot;: &quot;A String&quot;, # An opaque ID of this project.
&quot;kind&quot;: &quot;A String&quot;, # The resource type.
&quot;numericId&quot;: &quot;A String&quot;, # The numeric ID of this project.
&quot;projectReference&quot;: { # A unique reference to a project. # A unique reference to this project.
&quot;projectId&quot;: &quot;A String&quot;, # Required. ID of the project. Can be either the numeric ID or the assigned ID of the project.
},
},
],
&quot;totalItems&quot;: 42, # The total number of projects in the page. A wrapper is used here because the field should still be in the response when the value is 0.
}</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>