Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f46ea5502e604e4b8e7149dc65d57be67f00e4c6 / . / docs / dyn / books.v1.layers.html
blob: 940bcdb9442ad7232360a62623feefbb8c0c9147 [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-annotationData"><strong><a href="books.v1.layers.annotationData.html">annotationData</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
18
19<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;the&nbsp;layer&nbsp;summary&nbsp;for&nbsp;a&nbsp;volume.<br>
20&nbsp;<br>
21Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]22&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]24&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]25&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;The&nbsp;volume&nbsp;to&nbsp;retrieve&nbsp;layers&nbsp;for.&nbsp;(required)<br>
26&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
27&nbsp;&nbsp;contentVersion:&nbsp;string,&nbsp;The&nbsp;content&nbsp;version&nbsp;for&nbsp;the&nbsp;requested&nbsp;volume.<br>
28&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]29&nbsp;&nbsp;summaryId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;layer&nbsp;to&nbsp;get&nbsp;the&nbsp;summary&nbsp;for.&nbsp;(required)<br>
30&nbsp;<br>
31Returns:<br>
32&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
33&nbsp;<br>
34&nbsp;&nbsp;&nbsp;&nbsp;{<br>
35&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#layersummary",&nbsp;#&nbsp;Resource&nbsp;Type<br>
36&nbsp;&nbsp;&nbsp;&nbsp;"annotationCount":&nbsp;42,&nbsp;#&nbsp;The&nbsp;number&nbsp;of&nbsp;annotations&nbsp;for&nbsp;this&nbsp;layer.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;"dataCount":&nbsp;42,&nbsp;#&nbsp;The&nbsp;number&nbsp;of&nbsp;data&nbsp;items&nbsp;for&nbsp;this&nbsp;layer.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;"annotationsLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;link&nbsp;to&nbsp;get&nbsp;the&nbsp;annotations&nbsp;for&nbsp;this&nbsp;layer.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;an&nbsp;item&nbsp;in&nbsp;this&nbsp;layer&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>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]40&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;id&nbsp;this&nbsp;resource&nbsp;is&nbsp;for.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;id&nbsp;of&nbsp;this&nbsp;layer&nbsp;summary.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;"annotationTypes":&nbsp;[&nbsp;#&nbsp;The&nbsp;list&nbsp;of&nbsp;annotation&nbsp;types&nbsp;contained&nbsp;for&nbsp;this&nbsp;layer.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
44&nbsp;&nbsp;&nbsp;&nbsp;],<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]45&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;version&nbsp;this&nbsp;resource&nbsp;is&nbsp;for.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]46&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;layer&nbsp;id&nbsp;for&nbsp;this&nbsp;summary.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]47&nbsp;&nbsp;&nbsp;&nbsp;"annotationsDataLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;get&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]48&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
49&nbsp;&nbsp;}</tt></dd></dl>
50
51<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;the&nbsp;layer&nbsp;summaries&nbsp;for&nbsp;a&nbsp;volume.<br>
52&nbsp;<br>
53Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]54&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
55&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
56&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;value&nbsp;of&nbsp;the&nbsp;nextToken&nbsp;from&nbsp;the&nbsp;previous&nbsp;page.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]57&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;The&nbsp;volume&nbsp;to&nbsp;retrieve&nbsp;layers&nbsp;for.&nbsp;(required)<br>
58&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]59&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]60&nbsp;&nbsp;contentVersion:&nbsp;string,&nbsp;The&nbsp;content&nbsp;version&nbsp;for&nbsp;the&nbsp;requested&nbsp;volume.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]61&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
62&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]63&nbsp;<br>
64Returns:<br>
65&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
66&nbsp;<br>
67&nbsp;&nbsp;&nbsp;&nbsp;{<br>
68&nbsp;&nbsp;&nbsp;&nbsp;"totalItems":&nbsp;42,&nbsp;#&nbsp;The&nbsp;total&nbsp;number&nbsp;of&nbsp;layer&nbsp;summaries&nbsp;found.<br>
69&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;layer&nbsp;summary&nbsp;items.<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#layersummary",&nbsp;#&nbsp;Resource&nbsp;Type<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"annotationCount":&nbsp;42,&nbsp;#&nbsp;The&nbsp;number&nbsp;of&nbsp;annotations&nbsp;for&nbsp;this&nbsp;layer.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataCount":&nbsp;42,&nbsp;#&nbsp;The&nbsp;number&nbsp;of&nbsp;data&nbsp;items&nbsp;for&nbsp;this&nbsp;layer.<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"annotationsLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;link&nbsp;to&nbsp;get&nbsp;the&nbsp;annotations&nbsp;for&nbsp;this&nbsp;layer.<br>
75&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;an&nbsp;item&nbsp;in&nbsp;this&nbsp;layer&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>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;id&nbsp;this&nbsp;resource&nbsp;is&nbsp;for.<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;id&nbsp;of&nbsp;this&nbsp;layer&nbsp;summary.<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"annotationTypes":&nbsp;[&nbsp;#&nbsp;The&nbsp;list&nbsp;of&nbsp;annotation&nbsp;types&nbsp;contained&nbsp;for&nbsp;this&nbsp;layer.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contentVersion":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;version&nbsp;this&nbsp;resource&nbsp;is&nbsp;for.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]82&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;summary.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"annotationsDataLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;get&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation.<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
86&nbsp;&nbsp;&nbsp;&nbsp;],<br>
87&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#layersummaries",&nbsp;#&nbsp;Resource&nbsp;type.<br>
88&nbsp;&nbsp;}</tt></dd></dl>
89
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]90<dl><dt><a name="Resource-volumeAnnotations"><strong><a href="books.v1.layers.volumeAnnotations.html">volumeAnnotations</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
91
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]92<hr>
93Data descriptors defined here:<br>
94<dl><dt><strong>__dict__</strong></dt>
95<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
96</dl>
97<dl><dt><strong>__weakref__</strong></dt>
98<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
99</dl>
100</td></tr></table>
101</body></html>