blob: 8f06e1448dd2d5111a229e92d41ca1de26106e9b [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="libraryagent_v1.html">Library Agent API</a> . <a href="libraryagent_v1.shelves.html">shelves</a> . <a href="libraryagent_v1.shelves.books.html">books</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#borrow">borrow(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070079<p class="firstline">Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions.</p>
80<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a book. Returns NOT_FOUND if the book does not exist.</p>
86<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080087 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#return_">return_(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094<p class="firstline">Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn't borrow before.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="borrow">borrow(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070098 <pre>Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099
100Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 name: string, Required. The name of the book to borrow. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 { # A single book in the library.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800111 &quot;author&quot;: &quot;A String&quot;, # The name of the book author.
112 &quot;name&quot;: &quot;A String&quot;, # The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book.
113 &quot;read&quot;: True or False, # Value indicating whether the book has been read.
114 &quot;title&quot;: &quot;A String&quot;, # The title of the book.
115}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116</div>
117
118<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700119 <code class="details" id="close">close()</code>
120 <pre>Close httplib2 connections.</pre>
121</div>
122
123<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 <code class="details" id="get">get(name, x__xgafv=None)</code>
125 <pre>Gets a book. Returns NOT_FOUND if the book does not exist.
126
127Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700128 name: string, Required. The name of the book to retrieve. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134Returns:
135 An object of the form:
136
137 { # A single book in the library.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &quot;author&quot;: &quot;A String&quot;, # The name of the book author.
139 &quot;name&quot;: &quot;A String&quot;, # The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book.
140 &quot;read&quot;: True or False, # Value indicating whether the book has been read.
141 &quot;title&quot;: &quot;A String&quot;, # The title of the book.
142}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143</div>
144
145<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800146 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 <pre>Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700148
149Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700150 parent: string, Required. The name of the shelf whose books we&#x27;d like to list. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800151 pageSize: integer, Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800152 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListBooksResponse.next_page_token. returned from the previous call to `ListBooks` method.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700157
158Returns:
159 An object of the form:
160
161 { # Response message for LibraryAgent.ListBooks.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 &quot;books&quot;: [ # The list of books.
163 { # A single book in the library.
164 &quot;author&quot;: &quot;A String&quot;, # The name of the book author.
165 &quot;name&quot;: &quot;A String&quot;, # The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book.
166 &quot;read&quot;: True or False, # Value indicating whether the book has been read.
167 &quot;title&quot;: &quot;A String&quot;, # The title of the book.
168 },
169 ],
170 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve next page of results. Pass this value in the ListBooksRequest.page_token field in the subsequent call to `ListBooks` method to retrieve the next page of results.
171}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700172</div>
173
174<div class="method">
175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176 <pre>Retrieves the next page of results.
177
178Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700183 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700184 page. Returns None if there are no more items in the collection.
185 </pre>
186</div>
187
188<div class="method">
189 <code class="details" id="return_">return_(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700190 <pre>Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn&#x27;t borrow before.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700191
192Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700193 name: string, Required. The name of the book to return. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
202 { # A single book in the library.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800203 &quot;author&quot;: &quot;A String&quot;, # The name of the book author.
204 &quot;name&quot;: &quot;A String&quot;, # The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book.
205 &quot;read&quot;: True or False, # Value indicating whether the book has been read.
206 &quot;title&quot;: &quot;A String&quot;, # The title of the book.
207}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208</div>
209
210</body></html>