Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / books_v1.cloudloading.html
blob: 003ee9cb7c4ac7321c50b8a1665926eef216b6c2 [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]78 <code><a href="#addBook">addBook(name=None, mime_type=None, drive_document_id=None, upload_client_token=None, x__xgafv=None)</a></code></p>
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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#deleteBook">deleteBook(volumeId=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Remove the book and its contents</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#updateBook">updateBook(body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Updates a user-upload volume.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88 <code class="details" id="addBook">addBook(name=None, mime_type=None, drive_document_id=None, upload_client_token=None, x__xgafv=None)</code>
89 <pre>Add a user-upload volume and triggers processing.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90
91Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 name: string, The document name. It can be set only if the drive_document_id is set.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 mime_type: string, The document MIME type. It can be set only if the drive_document_id is set.
94 drive_document_id: string, A drive document id. The upload_client_token must not be set.
95 upload_client_token: string, Scotty upload token.
96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]100
101Returns:
102 An object of the form:
103
104 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;title&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 &quot;author&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;volumeId&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 &quot;processingState&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]109 }</pre>
110</div>
111
112<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]113 <code class="details" id="deleteBook">deleteBook(volumeId=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 <pre>Remove the book and its contents
115
116Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 volumeId: string, The id of the book to be removed.
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
126 { # 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 `{}`.
127 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128</div>
129
130<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 <code class="details" id="updateBook">updateBook(body=None, x__xgafv=None)</code>
132 <pre>Updates a user-upload volume.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133
134Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]135 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 The object takes the form of:
137
138{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;title&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]140 &quot;author&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;volumeId&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 &quot;processingState&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143}
144
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149
150Returns:
151 An object of the form:
152
153 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &quot;title&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]155 &quot;author&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &quot;volumeId&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]157 &quot;processingState&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 }</pre>
159</div>
160
161</body></html>