Blame - docs/dyn/libraryagent_v1.shelves.books.html - platform/external/python/google-api-python-client

blob: 8f06e1448dd2d5111a229e92d41ca1de26106e9b [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	79	<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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	87	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	89	<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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	95	<h3>Method Details</h3>
				96	<div class="method">
				97	<code class="details" id="borrow">borrow(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	98	<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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	99
				100	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	101	name: string, Required. The name of the book to borrow. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	102	x__xgafv: string, V1 error format.
				103	Allowed values
				104	1 - v1 error format
				105	2 - v2 error format
				106
				107	Returns:
				108	An object of the form:
				109
				110	{ # A single book in the library.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	111	"author": "A String", # The name of the book author.
				112	"name": "A String", # 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	"read": True or False, # Value indicating whether the book has been read.
				114	"title": "A String", # The title of the book.
				115	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	116	</div>
				117
				118	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119	<code class="details" id="close">close()</code>
				120	<pre>Close httplib2 connections.</pre>
				121	</div>
				122
				123	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	124	<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
				127	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	128	name: string, Required. The name of the book to retrieve. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	129	x__xgafv: string, V1 error format.
				130	Allowed values
				131	1 - v1 error format
				132	2 - v2 error format
				133
				134	Returns:
				135	An object of the form:
				136
				137	{ # A single book in the library.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	138	"author": "A String", # The name of the book author.
				139	"name": "A String", # 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	"read": True or False, # Value indicating whether the book has been read.
				141	"title": "A String", # The title of the book.
				142	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	143	</div>
				144
				145	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	146	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	147	<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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	148
				149	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	150	parent: string, Required. The name of the shelf whose books we'd like to list. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	151	pageSize: integer, Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	152	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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	153	x__xgafv: string, V1 error format.
				154	Allowed values
				155	1 - v1 error format
				156	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	157
				158	Returns:
				159	An object of the form:
				160
				161	{ # Response message for LibraryAgent.ListBooks.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	162	"books": [ # The list of books.
				163	{ # A single book in the library.
				164	"author": "A String", # The name of the book author.
				165	"name": "A String", # 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	"read": True or False, # Value indicating whether the book has been read.
				167	"title": "A String", # The title of the book.
				168	},
				169	],
				170	"nextPageToken": "A String", # 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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	</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
				178	Args:
				179	previous_request: The request for the previous page. (required)
				180	previous_response: The response from the request for the previous page. (required)
				181
				182	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	183	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	184	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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	190	<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't borrow before.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	191
				192	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	193	name: string, Required. The name of the book to return. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	194	x__xgafv: string, V1 error format.
				195	Allowed values
				196	1 - v1 error format
				197	2 - v2 error format
				198
				199	Returns:
				200	An object of the form:
				201
				202	{ # A single book in the library.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	203	"author": "A String", # The name of the book author.
				204	"name": "A String", # 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	"read": True or False, # Value indicating whether the book has been read.
				206	"title": "A String", # The title of the book.
				207	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	208	</div>
				209
				210	</body></html>