Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1c4cfdb76560f757cec9dbc56a290ee748a07ef0 / . / docs / dyn / books_v1.cloudloading.html
blob: 27b66f58eb76dda2cbdb8f1064de5e1972d2a322 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<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="books_v1.html">Books API</a> . <a href="books_v1.cloudloading.html">cloudloading</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]78 <code><a href="#addBook">addBook(drive_document_id=None, mime_type=None, name=None, upload_client_token=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]79<p class="firstline">Add a user-upload volume and triggers processing.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]84 <code><a href="#deleteBook">deleteBook(volumeId, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Remove the book and its contents</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#updateBook">updateBook(body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Updates a user-upload volume.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]91 <code class="details" id="addBook">addBook(drive_document_id=None, mime_type=None, name=None, upload_client_token=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]92 <pre>Add a user-upload volume and triggers processing.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93
94Args:
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]95 drive_document_id: string, A drive document id. The upload_client_token must not be set.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]96 mime_type: string, The document MIME type. It can be set only if the drive_document_id is set.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]97 name: string, The document name. It can be set only if the drive_document_id is set.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]98 upload_client_token: string, Scotty upload token.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103
104Returns:
105 An object of the form:
106
107 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]108 &quot;author&quot;: &quot;A String&quot;,
109 &quot;processingState&quot;: &quot;A String&quot;,
110 &quot;title&quot;: &quot;A String&quot;,
111 &quot;volumeId&quot;: &quot;A String&quot;,
112}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]113</div>
114
115<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116 <code class="details" id="close">close()</code>
117 <pre>Close httplib2 connections.</pre>
118</div>
119
120<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]121 <code class="details" id="deleteBook">deleteBook(volumeId, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122 <pre>Remove the book and its contents
123
124Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]125 volumeId: string, The id of the book to be removed. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131Returns:
132 An object of the form:
133
134 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]135}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136</div>
137
138<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 <code class="details" id="updateBook">updateBook(body=None, x__xgafv=None)</code>
140 <pre>Updates a user-upload volume.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141
142Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 The object takes the form of:
145
146{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]147 &quot;author&quot;: &quot;A String&quot;,
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]148 &quot;processingState&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]149 &quot;title&quot;: &quot;A String&quot;,
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]150 &quot;volumeId&quot;: &quot;A String&quot;,
151}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]157
158Returns:
159 An object of the form:
160
161 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]162 &quot;author&quot;: &quot;A String&quot;,
163 &quot;processingState&quot;: &quot;A String&quot;,
164 &quot;title&quot;: &quot;A String&quot;,
165 &quot;volumeId&quot;: &quot;A String&quot;,
166}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167</div>
168
169</body></html>