com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Media.Download

java.lang.Object

java.util.AbstractMap<String,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.discoveryengine.v1.DiscoveryEngineRequest<GdataMedia>

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Media.Download

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Media

public class DiscoveryEngine.Media.Download
extends DiscoveryEngineRequest<GdataMedia>

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

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

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

Map.Entry<K,V>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Download(String name) Downloads a file from the session.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.GenericUrl	buildHttpRequestUrl()
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFileId() Required.
String	getName() Required.
String	getViewId() Optional.
DiscoveryEngine.Media.Download	set(String parameterName, Object value)
DiscoveryEngine.Media.Download	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Media.Download	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Media.Download	setAlt(String alt) Data format for response.
DiscoveryEngine.Media.Download	setCallback(String callback) JSONP
DiscoveryEngine.Media.Download	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Media.Download	setFileId(String fileId) Required.
DiscoveryEngine.Media.Download	setKey(String key) API key.
DiscoveryEngine.Media.Download	setName(String name) Required.
DiscoveryEngine.Media.Download	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Media.Download	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Media.Download	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Media.Download	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Media.Download	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
DiscoveryEngine.Media.Download	setViewId(String viewId) Optional.

Methods inherited from class com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest

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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, 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

Download

protected Download(String name)

Downloads a file from the session. Create a request for the method "media.download". This request holds the parameters needed by the the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

name - Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collect ions/{collection}/engines/{engine}/sessions/{session}`

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:

executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GdataMedia>

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GdataMedia>

Throws:

IOException

executeMedia

public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws IOException

Overrides:

executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GdataMedia>

Throws:

IOException

buildHttpRequestUrl

public com.google.api.client.http.GenericUrl buildHttpRequestUrl()

Overrides:

buildHttpRequestUrl in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GdataMedia>

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GdataMedia>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GdataMedia>

Throws:

IOException

set$Xgafv

public DiscoveryEngine.Media.Download set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GdataMedia>

setAccessToken

public DiscoveryEngine.Media.Download setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GdataMedia>

setAlt

public DiscoveryEngine.Media.Download setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GdataMedia>

setCallback

public DiscoveryEngine.Media.Download setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GdataMedia>

setFields

public DiscoveryEngine.Media.Download setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GdataMedia>

setKey

public DiscoveryEngine.Media.Download setKey(String key)

Description copied from class: DiscoveryEngineRequest

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 DiscoveryEngineRequest<GdataMedia>

setOauthToken

public DiscoveryEngine.Media.Download setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GdataMedia>

setPrettyPrint

public DiscoveryEngine.Media.Download setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GdataMedia>

setQuotaUser

public DiscoveryEngine.Media.Download setQuotaUser(String quotaUser)

Description copied from class: DiscoveryEngineRequest

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 DiscoveryEngineRequest<GdataMedia>

setUploadType

public DiscoveryEngine.Media.Download setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GdataMedia>

setUploadProtocol

public DiscoveryEngine.Media.Download setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GdataMedia>

getName

public String getName()

Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collec tions/{collection}/engines/{engine}/sessions/{session}`

setName

public DiscoveryEngine.Media.Download setName(String name)

Required. The resource name of the Session. Format: `projects/{project}/locations/{location }/collections/{collection}/engines/{engine}/sessions/{session}`

getFileId

public String getFileId()

Required. The ID of the file to be downloaded.

setFileId

public DiscoveryEngine.Media.Download setFileId(String fileId)

Required. The ID of the file to be downloaded.

getViewId

public String getViewId()

Optional. The ID of the view to be downloaded.

setViewId

public DiscoveryEngine.Media.Download setViewId(String viewId)

Optional. The ID of the view to be downloaded.

set

public DiscoveryEngine.Media.Download set(String parameterName,
                                          Object value)

Overrides:

set in class DiscoveryEngineRequest<GdataMedia>