openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
d6b11065654f34e54c32cbd7b0e2da7bca04d3f0
deb-python-oauth2client/docs/dyn/books.v1.bookshelves.html
Joe Gregorio 3d55ac5b60 Update generated docs.
2012-02-21 10:11:19 -05:00

80 lines
6.6 KiB
HTML
Raw Blame History

<!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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;metadata&nbsp;for&nbsp;a&nbsp;specific&nbsp;bookshelf&nbsp;for&nbsp;the&nbsp;specified&nbsp;user.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;retrieve&nbsp;bookshelves.&nbsp;(required)<br>
&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;to&nbsp;retrieve.&nbsp;(required)<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;"kind":&nbsp;"books#bookshelf",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;bookshelf&nbsp;metadata.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Created&nbsp;time&nbsp;for&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
&nbsp;&nbsp;&nbsp;&nbsp;"volumeCount":&nbsp;42,&nbsp;#&nbsp;Number&nbsp;of&nbsp;volumes&nbsp;in&nbsp;this&nbsp;bookshelf.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modified&nbsp;time&nbsp;of&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
&nbsp;&nbsp;&nbsp;&nbsp;"access":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Whether&nbsp;this&nbsp;bookshelf&nbsp;is&nbsp;PUBLIC&nbsp;or&nbsp;PRIVATE.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"volumesLastUpdated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;time&nbsp;a&nbsp;volume&nbsp;was&nbsp;added&nbsp;or&nbsp;removed&nbsp;from&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;bookshelf,&nbsp;only&nbsp;unique&nbsp;by&nbsp;user.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;public&nbsp;bookshelves&nbsp;for&nbsp;the&nbsp;specified&nbsp;user.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;retrieve&nbsp;bookshelves.&nbsp;(required)<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;A&nbsp;list&nbsp;of&nbsp;bookshelves.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelf",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;bookshelf&nbsp;metadata.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Created&nbsp;time&nbsp;for&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeCount":&nbsp;42,&nbsp;#&nbsp;Number&nbsp;of&nbsp;volumes&nbsp;in&nbsp;this&nbsp;bookshelf.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modified&nbsp;time&nbsp;of&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"access":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Whether&nbsp;this&nbsp;bookshelf&nbsp;is&nbsp;PUBLIC&nbsp;or&nbsp;PRIVATE.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumesLastUpdated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;time&nbsp;a&nbsp;volume&nbsp;was&nbsp;added&nbsp;or&nbsp;removed&nbsp;from&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;bookshelf,&nbsp;only&nbsp;unique&nbsp;by&nbsp;user.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelves",&nbsp;#&nbsp;Resource&nbsp;type.<br>
&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.bookshelves.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</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>
View Git Blame Copy Permalink