/
cloudsupport_v2beta.media.html
401 lines (371 loc) 路 28.8 KB
/
cloudsupport_v2beta.media.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudsupport_v2beta.html">Google Cloud Support API</a> . <a href="cloudsupport_v2beta.media.html">media</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#download">download(name, x__xgafv=None)</a></code></p>
<p class="firstline">Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL.</p>
<p class="toc_element">
<code><a href="#download_media">download_media(name, x__xgafv=None)</a></code></p>
<p class="firstline">Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL.</p>
<p class="toc_element">
<code><a href="#upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="download">download(name, x__xgafv=None)</code>
<pre>Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL.
Args:
name: string, The resource name of the attachment to be downloaded. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # # gdata.* are outside protos with mising documentation
"algorithm": "A String", # # gdata.* are outside protos with mising documentation
"bigstoreObjectRef": "A String", # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"compositeMedia": [ # # gdata.* are outside protos with mising documentation
{ # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
},
],
"contentType": "A String", # # gdata.* are outside protos with mising documentation
"contentTypeInfo": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bestGuess": "A String", # # gdata.* are outside protos with mising documentation
"fromBytes": "A String", # # gdata.* are outside protos with mising documentation
"fromFileName": "A String", # # gdata.* are outside protos with mising documentation
"fromHeader": "A String", # # gdata.* are outside protos with mising documentation
"fromUrlPath": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"diffChecksumsResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"checksumsLocation": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
},
"chunkSizeBytes": "A String", # # gdata.* are outside protos with mising documentation
"objectLocation": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
},
"objectSizeBytes": "A String", # # gdata.* are outside protos with mising documentation
"objectVersion": "A String", # # gdata.* are outside protos with mising documentation
},
"diffDownloadResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"objectLocation": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
},
},
"diffUploadRequest": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"checksumsInfo": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
},
"objectInfo": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
},
"objectVersion": "A String", # # gdata.* are outside protos with mising documentation
},
"diffUploadResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"objectVersion": "A String", # # gdata.* are outside protos with mising documentation
"originalObject": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobRef": "A String", # # gdata.* are outside protos with mising documentation
"blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
"blobId": "A String", # # gdata.* are outside protos with mising documentation
"downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
"readToken": "A String", # # gdata.* are outside protos with mising documentation
"uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
},
"cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
"crc32cHash": 42, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
},
},
"diffVersionResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"objectSizeBytes": "A String", # # gdata.* are outside protos with mising documentation
"objectVersion": "A String", # # gdata.* are outside protos with mising documentation
},
"downloadParameters": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"allowGzipCompression": True or False, # # gdata.* are outside protos with mising documentation
"ignoreRange": True or False, # # gdata.* are outside protos with mising documentation
},
"filename": "A String", # # gdata.* are outside protos with mising documentation
"hash": "A String", # # gdata.* are outside protos with mising documentation
"hashVerified": True or False, # # gdata.* are outside protos with mising documentation
"inline": "A String", # # gdata.* are outside protos with mising documentation
"isPotentialRetry": True or False, # # gdata.* are outside protos with mising documentation
"length": "A String", # # gdata.* are outside protos with mising documentation
"md5Hash": "A String", # # gdata.* are outside protos with mising documentation
"mediaId": "A String", # # gdata.* are outside protos with mising documentation
"objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
"bucketName": "A String", # # gdata.* are outside protos with mising documentation
"generation": "A String", # # gdata.* are outside protos with mising documentation
"objectName": "A String", # # gdata.* are outside protos with mising documentation
},
"path": "A String", # # gdata.* are outside protos with mising documentation
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
"sha256Hash": "A String", # # gdata.* are outside protos with mising documentation
"timestamp": "A String", # # gdata.* are outside protos with mising documentation
"token": "A String", # # gdata.* are outside protos with mising documentation
}</pre>
</div>
<div class="method">
<code class="details" id="download_media">download_media(name, x__xgafv=None)</code>
<pre>Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL.
Args:
name: string, The resource name of the attachment to be downloaded. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
<pre>Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.
Args:
parent: string, Required. The resource name of the case (or case parent) to which the attachment should be attached. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for the CreateAttachment endpoint.
"attachment": { # Represents a file attached to a support case. # Required. The attachment to be created.
"createTime": "A String", # Output only. The time at which the attachment was created.
"creator": { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
"displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
"email": "A String", # The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
"googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
},
"filename": "A String", # The filename of the attachment (e.g. `"graph.jpg"`).
"mimeType": "A String", # Output only. The MIME type of the attachment (e.g. text/plain).
"name": "A String", # Output only. The resource name of the attachment.
"sizeBytes": "A String", # Output only. The size of the attachment in bytes.
},
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a file attached to a support case.
"createTime": "A String", # Output only. The time at which the attachment was created.
"creator": { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
"displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
"email": "A String", # The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
"googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
},
"filename": "A String", # The filename of the attachment (e.g. `"graph.jpg"`).
"mimeType": "A String", # Output only. The MIME type of the attachment (e.g. text/plain).
"name": "A String", # Output only. The resource name of the attachment.
"sizeBytes": "A String", # Output only. The size of the attachment in bytes.
}</pre>
</div>
</body></html>