com.google.api.services.drive

Class Drive.Files.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.drive.DriveRequest<Operation>

com.google.api.services.drive.Drive.Files.Download

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.Download
extends DriveRequest<Operation>

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 fileId) Downloads the content of a file.

Method Summary

Modifier and Type	Method and Description
String	getFileId() Required.
String	getMimeType() Optional.
String	getRevisionId() Optional.
Drive.Files.Download	set(String parameterName, Object value)
Drive.Files.Download	set$Xgafv(String $Xgafv) V1 error format.
Drive.Files.Download	setAccessToken(String accessToken) OAuth access token.
Drive.Files.Download	setAlt(String alt) Data format for response.
Drive.Files.Download	setCallback(String callback) JSONP
Drive.Files.Download	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Download	setFileId(String fileId) Required.
Drive.Files.Download	setKey(String key) API key.
Drive.Files.Download	setMimeType(String mimeType) Optional.
Drive.Files.Download	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Download	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Download	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Files.Download	setRevisionId(String revisionId) Optional.
Drive.Files.Download	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Drive.Files.Download	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.drive.DriveRequest

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, 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 fileId)

Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation. Create a request for the method "files.download". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

fileId - Required. The ID of the file to download.

Since:

1.13

Method Detail

set$Xgafv

public Drive.Files.Download set$Xgafv(String $Xgafv)

Description copied from class: DriveRequest

V1 error format.

Overrides:

set$Xgafv in class DriveRequest<Operation>

setAccessToken

public Drive.Files.Download setAccessToken(String accessToken)

Description copied from class: DriveRequest

OAuth access token.

Overrides:

setAccessToken in class DriveRequest<Operation>

setAlt

public Drive.Files.Download setAlt(String alt)

Description copied from class: DriveRequest

Data format for response.

Overrides:

setAlt in class DriveRequest<Operation>

setCallback

public Drive.Files.Download setCallback(String callback)

Description copied from class: DriveRequest

JSONP

Overrides:

setCallback in class DriveRequest<Operation>

setFields

public Drive.Files.Download setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<Operation>

setKey

public Drive.Files.Download setKey(String key)

Description copied from class: DriveRequest

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 DriveRequest<Operation>

setOauthToken

public Drive.Files.Download setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<Operation>

setPrettyPrint

public Drive.Files.Download setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<Operation>

setQuotaUser

public Drive.Files.Download setQuotaUser(String quotaUser)

Description copied from class: DriveRequest

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 DriveRequest<Operation>

setUploadType

public Drive.Files.Download setUploadType(String uploadType)

Description copied from class: DriveRequest

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

Overrides:

setUploadType in class DriveRequest<Operation>

setUploadProtocol

public Drive.Files.Download setUploadProtocol(String uploadProtocol)

Description copied from class: DriveRequest

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

Overrides:

setUploadProtocol in class DriveRequest<Operation>

getFileId

public String getFileId()

Required. The ID of the file to download.

setFileId

public Drive.Files.Download setFileId(String fileId)

Required. The ID of the file to download.

getMimeType

public String getMimeType()

Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.

setMimeType

public Drive.Files.Download setMimeType(String mimeType)

Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.

getRevisionId

public String getRevisionId()

Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.

setRevisionId

public Drive.Files.Download setRevisionId(String revisionId)

Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.

set

public Drive.Files.Download set(String parameterName,
                                Object value)

Overrides:

set in class DriveRequest<Operation>