Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / cloudsearch_v1.media.html
blob: 379c35ee1233413d97eef8fbd7c3ccf38ba8e85e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.media.html">media</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#upload">upload(resourceName, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Uploads media for indexing.</p>
80<h3>Method Details</h3>
81<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]82 <code class="details" id="upload">upload(resourceName, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <pre>Uploads media for indexing.
84
85The upload endpoint supports direct and resumable upload protocols and
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86is intended for large items that can not be
87[inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent).
88To index large content:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]901. Call
91 indexing.datasources.items.upload
92 with the resource name to begin an upload session and retrieve the
93 UploadItemRef.
941. Call media.upload to upload the content using the same resource name from step 1.
951. Call indexing.datasources.items.index
96 to index the item. Populate the
97 [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent)
98 with the UploadItemRef from step 1.
99
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100
101For additional information, see
102[Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest).
103
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 **Note:** This API requires a service account to execute.
105
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106Args:
107 resourceName: string, Name of the media that is being downloaded. See
108ReadRequest.resource_name. (required)
109 body: object, The request body.
110 The object takes the form of:
111
112{ # Media resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;resourceName&quot;: &quot;A String&quot;, # Name of the media resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 }
115
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
121 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122
123Returns:
124 An object of the form:
125
126 { # Media resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 &quot;resourceName&quot;: &quot;A String&quot;, # Name of the media resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 }</pre>
129</div>
130
131</body></html>