blob: 0e2fe51bb07422770334841c001d9f569f877ff8 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Resource</title>
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists&nbsp;the&nbsp;projects&nbsp;to&nbsp;which&nbsp;you&nbsp;have&nbsp;at&nbsp;least&nbsp;read&nbsp;access.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;Page&nbsp;token,&nbsp;returned&nbsp;by&nbsp;a&nbsp;previous&nbsp;call,&nbsp;to&nbsp;request&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results<br>
&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return<br>
&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;token&nbsp;to&nbsp;request&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"totalItems":&nbsp;42,&nbsp;#&nbsp;The&nbsp;total&nbsp;number&nbsp;of&nbsp;projects&nbsp;in&nbsp;the&nbsp;list.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"bigquery#projectList",&nbsp;#&nbsp;The&nbsp;type&nbsp;of&nbsp;list.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;hash&nbsp;of&nbsp;the&nbsp;page&nbsp;of&nbsp;results<br>
&nbsp;&nbsp;&nbsp;&nbsp;"projects":&nbsp;[&nbsp;#&nbsp;Projects&nbsp;to&nbsp;which&nbsp;you&nbsp;have&nbsp;at&nbsp;least&nbsp;READ&nbsp;access.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"friendlyName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;descriptive&nbsp;name&nbsp;for&nbsp;this&nbsp;project.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"bigquery#project",&nbsp;#&nbsp;The&nbsp;resource&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;An&nbsp;opaque&nbsp;ID&nbsp;of&nbsp;this&nbsp;project.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"projectReference":&nbsp;{&nbsp;#&nbsp;A&nbsp;unique&nbsp;reference&nbsp;to&nbsp;this&nbsp;project.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"projectId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;[Required]&nbsp;ID&nbsp;of&nbsp;the&nbsp;project.&nbsp;Can&nbsp;be&nbsp;either&nbsp;the&nbsp;numeric&nbsp;ID&nbsp;or&nbsp;the&nbsp;assigned&nbsp;ID&nbsp;of&nbsp;the&nbsp;project.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>