com.google.api.services.cloudsearch.v1

Class CloudSearch.Media.Upload

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.cloudsearch.v1.CloudSearchRequest<Media>

com.google.api.services.cloudsearch.v1.CloudSearch.Media.Upload

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

CloudSearch.Media

public class CloudSearch.Media.Upload
extends CloudSearchRequest<Media>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Upload(java.lang.String resourceName, Media content) Uploads media for indexing.
protected	Upload(java.lang.String resourceName, Media content, com.google.api.client.http.AbstractInputStreamContent mediaContent) Uploads media for indexing.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getResourceName() Name of the media that is being downloaded.
CloudSearch.Media.Upload	set(java.lang.String parameterName, java.lang.Object value)
CloudSearch.Media.Upload	set$Xgafv(java.lang.String $Xgafv) V1 error format.
CloudSearch.Media.Upload	setAccessToken(java.lang.String accessToken) OAuth access token.
CloudSearch.Media.Upload	setAlt(java.lang.String alt) Data format for response.
CloudSearch.Media.Upload	setCallback(java.lang.String callback) JSONP
CloudSearch.Media.Upload	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
CloudSearch.Media.Upload	setKey(java.lang.String key) API key.
CloudSearch.Media.Upload	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
CloudSearch.Media.Upload	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
CloudSearch.Media.Upload	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
CloudSearch.Media.Upload	setResourceName(java.lang.String resourceName) Name of the media that is being downloaded.
CloudSearch.Media.Upload	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
CloudSearch.Media.Upload	setUploadType(java.lang.String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudsearch.v1.CloudSearchRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Upload

protected Upload(java.lang.String resourceName,
                 Media content)

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. Create a request for the method "media.upload". This request holds the parameters needed by the the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

CloudSearch.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

resourceName - Name of the media that is being downloaded. See ReadRequest.resource_name.

content - the Media

Since:

1.13

Upload

protected Upload(java.lang.String resourceName,
                 Media content,
                 com.google.api.client.http.AbstractInputStreamContent mediaContent)

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. Create a request for the method "media.upload". This request holds the parameters needed by the the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

CloudSearch.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

This constructor should be used for uploading media content.

Parameters:

resourceName - Name of the media that is being downloaded. See ReadRequest.resource_name.

content - the Media media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

set$Xgafv

public CloudSearch.Media.Upload set$Xgafv(java.lang.String $Xgafv)

Description copied from class: CloudSearchRequest

V1 error format.

Overrides:

set$Xgafv in class CloudSearchRequest<Media>

setAccessToken

public CloudSearch.Media.Upload setAccessToken(java.lang.String accessToken)

Description copied from class: CloudSearchRequest

OAuth access token.

Overrides:

setAccessToken in class CloudSearchRequest<Media>

setAlt

public CloudSearch.Media.Upload setAlt(java.lang.String alt)

Description copied from class: CloudSearchRequest

Data format for response.

Overrides:

setAlt in class CloudSearchRequest<Media>

setCallback

public CloudSearch.Media.Upload setCallback(java.lang.String callback)

Description copied from class: CloudSearchRequest

JSONP

Overrides:

setCallback in class CloudSearchRequest<Media>

setFields

public CloudSearch.Media.Upload setFields(java.lang.String fields)

Description copied from class: CloudSearchRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudSearchRequest<Media>

setKey

public CloudSearch.Media.Upload setKey(java.lang.String key)

Description copied from class: CloudSearchRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class CloudSearchRequest<Media>

setOauthToken

public CloudSearch.Media.Upload setOauthToken(java.lang.String oauthToken)

Description copied from class: CloudSearchRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudSearchRequest<Media>

setPrettyPrint

public CloudSearch.Media.Upload setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: CloudSearchRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudSearchRequest<Media>

setQuotaUser

public CloudSearch.Media.Upload setQuotaUser(java.lang.String quotaUser)

Description copied from class: CloudSearchRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class CloudSearchRequest<Media>

setUploadType

public CloudSearch.Media.Upload setUploadType(java.lang.String uploadType)

Description copied from class: CloudSearchRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudSearchRequest<Media>

setUploadProtocol

public CloudSearch.Media.Upload setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: CloudSearchRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudSearchRequest<Media>

getResourceName

public java.lang.String getResourceName()

Name of the media that is being downloaded. See ReadRequest.resource_name.

setResourceName

public CloudSearch.Media.Upload setResourceName(java.lang.String resourceName)

Name of the media that is being downloaded. See ReadRequest.resource_name.

set

public CloudSearch.Media.Upload set(java.lang.String parameterName,
                                    java.lang.Object value)

Overrides:

set in class CloudSearchRequest<Media>