Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c8e421c03c1e22f35060229ea1c696a85d9a3dbc / . / docs / dyn / books.v1.layers.annotationData.html
blob: d95bb1a18f99271d43feff348edc0906e1bbb111 [file] [log] [blame]
Joe Gregorio41899542012-04-23 09:02:05 -0400[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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;the&nbsp;annotation&nbsp;data.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
21&nbsp;&nbsp;locale:&nbsp;string,&nbsp;The&nbsp;locale&nbsp;information&nbsp;for&nbsp;the&nbsp;data.&nbsp;ISO-639-1&nbsp;language&nbsp;and&nbsp;ISO-3166-1&nbsp;country&nbsp;code.&nbsp;Ex:&nbsp;'en_US'.<br>
22&nbsp;&nbsp;layerId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;layer&nbsp;to&nbsp;get&nbsp;the&nbsp;annotations.&nbsp;(required)<br>
23&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;The&nbsp;volume&nbsp;to&nbsp;retrieve&nbsp;annotations&nbsp;for.&nbsp;(required)<br>
24&nbsp;&nbsp;annotationDataId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;annotation&nbsp;data&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
25&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
26&nbsp;<br>
27Returns:<br>
28&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
29&nbsp;<br>
30&nbsp;&nbsp;&nbsp;&nbsp;{<br>
31&nbsp;&nbsp;&nbsp;&nbsp;"annotationType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;type&nbsp;of&nbsp;annotation&nbsp;this&nbsp;data&nbsp;is&nbsp;for.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotationdata",&nbsp;#&nbsp;Resource&nbsp;Type<br>
33&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;data&nbsp;was&nbsp;updated.&nbsp;(<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;UTC&nbsp;date-time&nbsp;format).<br>
34&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
35&nbsp;&nbsp;&nbsp;&nbsp;"encoded_data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Base64&nbsp;encoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;Layer&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
37&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;JSON&nbsp;enoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;id&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;for&nbsp;this&nbsp;resource.&nbsp;*<br>
40&nbsp;&nbsp;}</tt></dd></dl>
41
42<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;the&nbsp;annotation&nbsp;data&nbsp;for&nbsp;a&nbsp;volume&nbsp;and&nbsp;layer.<br>
43&nbsp;<br>
44Args:<br>
45&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;value&nbsp;of&nbsp;the&nbsp;nextToken&nbsp;from&nbsp;the&nbsp;previous&nbsp;page.<br>
46&nbsp;&nbsp;updatedMax:&nbsp;string,&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp&nbsp;to&nbsp;restrict&nbsp;to&nbsp;items&nbsp;updated&nbsp;prior&nbsp;to&nbsp;this&nbsp;timestamp&nbsp;(exclusive).<br>
47&nbsp;&nbsp;locale:&nbsp;string,&nbsp;The&nbsp;locale&nbsp;information&nbsp;for&nbsp;the&nbsp;data.&nbsp;ISO-639-1&nbsp;language&nbsp;and&nbsp;ISO-3166-1&nbsp;country&nbsp;code.&nbsp;Ex:&nbsp;'en_US'.<br>
48&nbsp;&nbsp;layerId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;layer&nbsp;to&nbsp;get&nbsp;the&nbsp;annotation&nbsp;data.&nbsp;(required)<br>
49&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;The&nbsp;volume&nbsp;to&nbsp;retrieve&nbsp;annotation&nbsp;data&nbsp;for.&nbsp;(required)<br>
50&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return<br>
51&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
52&nbsp;&nbsp;contentVersion:&nbsp;string,&nbsp;The&nbsp;content&nbsp;version&nbsp;for&nbsp;the&nbsp;requested&nbsp;volume.&nbsp;(required)<br>
53&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
54&nbsp;&nbsp;updatedMin:&nbsp;string,&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp&nbsp;to&nbsp;restrict&nbsp;to&nbsp;items&nbsp;updated&nbsp;since&nbsp;this&nbsp;timestamp&nbsp;(inclusive).<br>
55&nbsp;<br>
56Returns:<br>
57&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
58&nbsp;<br>
59&nbsp;&nbsp;&nbsp;&nbsp;{<br>
60&nbsp;&nbsp;&nbsp;&nbsp;"totalItems":&nbsp;42,&nbsp;#&nbsp;The&nbsp;total&nbsp;number&nbsp;of&nbsp;volume&nbsp;annotations&nbsp;found.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;Annotation&nbsp;Data.<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"annotationType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;type&nbsp;of&nbsp;annotation&nbsp;this&nbsp;data&nbsp;is&nbsp;for.<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotationdata",&nbsp;#&nbsp;Resource&nbsp;Type<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;data&nbsp;was&nbsp;updated.&nbsp;(<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;UTC&nbsp;date-time&nbsp;format).<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"encoded_data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Base64&nbsp;encoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;Layer&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;JSON&nbsp;enoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;id&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;for&nbsp;this&nbsp;resource.&nbsp;*<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
73&nbsp;&nbsp;&nbsp;&nbsp;],<br>
74&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotationsdata",&nbsp;#&nbsp;Resource&nbsp;type<br>
75&nbsp;&nbsp;}</tt></dd></dl>
76
77<hr>
78Data descriptors defined here:<br>
79<dl><dt><strong>__dict__</strong></dt>
80<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
81</dl>
82<dl><dt><strong>__weakref__</strong></dt>
83<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
84</dl>
85</td></tr></table>
86</body></html>