Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df70dfcbf2c5a7f220ee1c216e4d73695c2b0237 / . / docs / dyn / discovery.v1.apis.html
blob: 79ed0c3595f6ddc49517c4f7beb5394d16a5acaa [file] [log] [blame]
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<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>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;api:&nbsp;string,&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;API.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]21&nbsp;&nbsp;version:&nbsp;string,&nbsp;The&nbsp;version&nbsp;of&nbsp;the&nbsp;API.&nbsp;(required)<br>
22&nbsp;<br>
23Returns:<br>
24&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
25&nbsp;<br>
26&nbsp;&nbsp;&nbsp;&nbsp;{<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame^]27&nbsp;&nbsp;&nbsp;&nbsp;"protocol":&nbsp;"rest",&nbsp;#&nbsp;The&nbsp;protocol&nbsp;described&nbsp;by&nbsp;this&nbsp;document.<br>
28&nbsp;&nbsp;&nbsp;&nbsp;"methods":&nbsp;{&nbsp;#&nbsp;API-level&nbsp;methods&nbsp;for&nbsp;this&nbsp;API.<br>
29&nbsp;&nbsp;&nbsp;&nbsp;},<br>
30&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>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
32&nbsp;&nbsp;&nbsp;&nbsp;],<br>
33&nbsp;&nbsp;&nbsp;&nbsp;"batchPath":&nbsp;"batch",&nbsp;#&nbsp;The&nbsp;path&nbsp;for&nbsp;REST&nbsp;batch&nbsp;requests.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;id&nbsp;of&nbsp;this&nbsp;API.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]35&nbsp;&nbsp;&nbsp;&nbsp;"schemas":&nbsp;{&nbsp;#&nbsp;The&nbsp;schemas&nbsp;for&nbsp;this&nbsp;API.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;},<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame^]37&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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]38&nbsp;&nbsp;&nbsp;&nbsp;"parameters":&nbsp;{&nbsp;#&nbsp;Common&nbsp;parameters&nbsp;that&nbsp;apply&nbsp;across&nbsp;all&nbsp;apis.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;},<br>
40&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>
41&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>
42&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>
43&nbsp;&nbsp;&nbsp;&nbsp;},<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame^]44&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>
45&nbsp;&nbsp;&nbsp;&nbsp;"version":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;version&nbsp;of&nbsp;this&nbsp;API.<br>
46&nbsp;&nbsp;&nbsp;&nbsp;"features":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;supported&nbsp;features&nbsp;for&nbsp;this&nbsp;API.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
48&nbsp;&nbsp;&nbsp;&nbsp;],<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame^]49&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>
50&nbsp;&nbsp;&nbsp;&nbsp;"resources":&nbsp;{&nbsp;#&nbsp;The&nbsp;resources&nbsp;in&nbsp;this&nbsp;API.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;},<br>
52&nbsp;&nbsp;&nbsp;&nbsp;"revision":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;version&nbsp;of&nbsp;this&nbsp;API.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description&nbsp;of&nbsp;this&nbsp;API.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]54&nbsp;&nbsp;&nbsp;&nbsp;"auth":&nbsp;{&nbsp;#&nbsp;Authentication&nbsp;information.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"oauth2":&nbsp;{&nbsp;#&nbsp;OAuth&nbsp;2.0&nbsp;authentication&nbsp;information.<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scopes":&nbsp;{&nbsp;#&nbsp;Available&nbsp;OAuth&nbsp;2.0&nbsp;scopes.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
59&nbsp;&nbsp;&nbsp;&nbsp;},<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame^]60&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"discovery#restDescription",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;this&nbsp;response.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]61&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;this&nbsp;API.<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame^]62&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>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]63&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;title&nbsp;of&nbsp;this&nbsp;API.<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]64&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>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]65&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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]66&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]67
68<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>
69&nbsp;<br>
70Args:<br>
71&nbsp;&nbsp;name:&nbsp;string,&nbsp;Only&nbsp;include&nbsp;APIs&nbsp;with&nbsp;the&nbsp;given&nbsp;name.<br>
72&nbsp;&nbsp;preferred:&nbsp;boolean,&nbsp;Return&nbsp;only&nbsp;the&nbsp;preferred&nbsp;version&nbsp;of&nbsp;an&nbsp;API.<br>
73&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>
74&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;deprecated&nbsp;-&nbsp;APIs&nbsp;that&nbsp;have&nbsp;been&nbsp;deprecated.<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;graduated&nbsp;-&nbsp;Supported&nbsp;APIs&nbsp;that&nbsp;have&nbsp;graduated&nbsp;from&nbsp;labs.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;labs&nbsp;-&nbsp;APIs&nbsp;that&nbsp;are&nbsp;experimental<br>
78&nbsp;<br>
79Returns:<br>
80&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
81&nbsp;<br>
82&nbsp;&nbsp;&nbsp;&nbsp;{<br>
83&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>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"discovery#directoryItem",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;this&nbsp;response.<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]86&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>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]89&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>
90&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>
91&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>
92&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>
93&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]94&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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]95&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>
96&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>
97&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>
98&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>
99&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>
100&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>
101&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>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
103&nbsp;&nbsp;&nbsp;&nbsp;],<br>
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame]104&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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]105&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"discovery#directoryList",&nbsp;#&nbsp;The&nbsp;kind&nbsp;for&nbsp;this&nbsp;response.<br>
106&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]107
108<hr>
109Data descriptors defined here:<br>
110<dl><dt><strong>__dict__</strong></dt>
111<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
112</dl>
113<dl><dt><strong>__weakref__</strong></dt>
114<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
115</dl>
116</td></tr></table>
117</body></html>