blob: 9acd60c360e4fdb0a688659497d6f6ecc1cba492 [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-getRest"><strong>getRest</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieve&nbsp;the&nbsp;description&nbsp;of&nbsp;a&nbsp;particular&nbsp;version&nbsp;of&nbsp;an&nbsp;api.<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;api:&nbsp;string,&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;API.&nbsp;(required)<br>
&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;version:&nbsp;string,&nbsp;The&nbsp;version&nbsp;of&nbsp;the&nbsp;API.&nbsp;(required)<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;"protocol":&nbsp;"rest",&nbsp;#&nbsp;The&nbsp;protocol&nbsp;described&nbsp;by&nbsp;this&nbsp;document.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"methods":&nbsp;{&nbsp;#&nbsp;API-level&nbsp;methods&nbsp;for&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"labels":&nbsp;[&nbsp;#&nbsp;Labels&nbsp;for&nbsp;the&nbsp;status&nbsp;of&nbsp;this&nbsp;API,&nbsp;such&nbsp;as&nbsp;labs&nbsp;or&nbsp;deprecated.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"batchPath":&nbsp;"batch",&nbsp;#&nbsp;The&nbsp;path&nbsp;for&nbsp;REST&nbsp;batch&nbsp;requests.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;id&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"schemas":&nbsp;{&nbsp;#&nbsp;The&nbsp;schemas&nbsp;for&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"rootUrl":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;root&nbsp;url&nbsp;under&nbsp;which&nbsp;all&nbsp;API&nbsp;services&nbsp;live.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"parameters":&nbsp;{&nbsp;#&nbsp;Common&nbsp;parameters&nbsp;that&nbsp;apply&nbsp;across&nbsp;all&nbsp;apis.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"icons":&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;16x16&nbsp;and&nbsp;32x32&nbsp;icons&nbsp;representing&nbsp;the&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"x32":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;of&nbsp;the&nbsp;32x32&nbsp;icon.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"x16":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;of&nbsp;the&nbsp;16x16&nbsp;icon.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"baseUrl":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;[DEPRECATED]&nbsp;The&nbsp;base&nbsp;URL&nbsp;for&nbsp;REST&nbsp;requests.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"version":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;version&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"features":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;supported&nbsp;features&nbsp;for&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"servicePath":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;base&nbsp;path&nbsp;for&nbsp;all&nbsp;REST&nbsp;requests.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"resources":&nbsp;{&nbsp;#&nbsp;The&nbsp;resources&nbsp;in&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"revision":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;version&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"auth":&nbsp;{&nbsp;#&nbsp;Authentication&nbsp;information.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"oauth2":&nbsp;{&nbsp;#&nbsp;OAuth&nbsp;2.0&nbsp;authentication&nbsp;information.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scopes":&nbsp;{&nbsp;#&nbsp;Available&nbsp;OAuth&nbsp;2.0&nbsp;scopes.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"discovery#restDescription",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;this&nbsp;response.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"basePath":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;[DEPRECATED]&nbsp;The&nbsp;base&nbsp;path&nbsp;for&nbsp;REST&nbsp;requests.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;title&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"discoveryVersion":&nbsp;"v1",&nbsp;#&nbsp;Indicate&nbsp;the&nbsp;version&nbsp;of&nbsp;the&nbsp;Discovery&nbsp;API&nbsp;used&nbsp;to&nbsp;generate&nbsp;this&nbsp;doc.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"documentationLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;link&nbsp;to&nbsp;human&nbsp;readable&nbsp;documentation&nbsp;for&nbsp;the&nbsp;API.<br>
&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieve&nbsp;the&nbsp;list&nbsp;of&nbsp;APIs&nbsp;supported&nbsp;at&nbsp;this&nbsp;endpoint.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;name:&nbsp;string,&nbsp;Only&nbsp;include&nbsp;APIs&nbsp;with&nbsp;the&nbsp;given&nbsp;name.<br>
&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;preferred:&nbsp;boolean,&nbsp;Return&nbsp;only&nbsp;the&nbsp;preferred&nbsp;version&nbsp;of&nbsp;an&nbsp;API.<br>
&nbsp;&nbsp;label:&nbsp;string,&nbsp;Only&nbsp;include&nbsp;APIs&nbsp;with&nbsp;a&nbsp;matching&nbsp;label,&nbsp;such&nbsp;as&nbsp;'graduated'&nbsp;or&nbsp;'labs'.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;deprecated&nbsp;-&nbsp;APIs&nbsp;that&nbsp;have&nbsp;been&nbsp;deprecated.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;graduated&nbsp;-&nbsp;Supported&nbsp;APIs&nbsp;that&nbsp;have&nbsp;graduated&nbsp;from&nbsp;labs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;labs&nbsp;-&nbsp;APIs&nbsp;that&nbsp;are&nbsp;experimental<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;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;individual&nbsp;directory&nbsp;entries.&nbsp;One&nbsp;entry&nbsp;per&nbsp;api/version&nbsp;pair.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"discovery#directoryItem",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;this&nbsp;response.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"labels":&nbsp;[&nbsp;#&nbsp;Labels&nbsp;for&nbsp;the&nbsp;status&nbsp;of&nbsp;this&nbsp;API,&nbsp;such&nbsp;as&nbsp;labs&nbsp;or&nbsp;deprecated.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"icons":&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;16x16&nbsp;and&nbsp;32x32&nbsp;icons&nbsp;representing&nbsp;the&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"x32":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;of&nbsp;the&nbsp;32x32&nbsp;icon.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"x16":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;of&nbsp;the&nbsp;16x16&nbsp;icon.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"discoveryRestUrl":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;for&nbsp;the&nbsp;discovery&nbsp;REST&nbsp;document.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"preferred":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;True&nbsp;if&nbsp;this&nbsp;version&nbsp;is&nbsp;the&nbsp;preferred&nbsp;version&nbsp;to&nbsp;use.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"discoveryLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;link&nbsp;to&nbsp;the&nbsp;discovery&nbsp;document.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"version":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;version&nbsp;of&nbsp;the&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;title&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;id&nbsp;of&nbsp;this&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"documentationLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;link&nbsp;to&nbsp;human&nbsp;readable&nbsp;documentation&nbsp;for&nbsp;the&nbsp;API.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"discoveryVersion":&nbsp;"v1",&nbsp;#&nbsp;Indicate&nbsp;the&nbsp;version&nbsp;of&nbsp;the&nbsp;Discovery&nbsp;API&nbsp;used&nbsp;to&nbsp;generate&nbsp;this&nbsp;doc.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"discovery#directoryList",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;this&nbsp;response.<br>
&nbsp;&nbsp;}</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>