blob: 379c35ee1233413d97eef8fbd7c3ccf38ba8e85e [file] [log] [blame]
<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="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.media.html">media</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#upload">upload(resourceName, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Uploads media for indexing.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="upload">upload(resourceName, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
<pre>Uploads media for indexing.
The upload endpoint supports direct and resumable upload protocols and
is intended for large items that can not be
[inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent).
To index large content:
1. Call
indexing.datasources.items.upload
with the resource name to begin an upload session and retrieve the
UploadItemRef.
1. Call media.upload to upload the content using the same resource name from step 1.
1. Call indexing.datasources.items.index
to index the item. Populate the
[ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent)
with the UploadItemRef from step 1.
For additional information, see
[Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest).
**Note:** This API requires a service account to execute.
Args:
resourceName: string, Name of the media that is being downloaded. See
ReadRequest.resource_name. (required)
body: object, The request body.
The object takes the form of:
{ # Media resource.
&quot;resourceName&quot;: &quot;A String&quot;, # Name of the media resource.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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.
Returns:
An object of the form:
{ # Media resource.
&quot;resourceName&quot;: &quot;A String&quot;, # Name of the media resource.
}</pre>
</div>
</body></html>