com.google.api.services.drive

Class Drive.Files.Export

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<Void>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.Export
extends DriveRequest<Void>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Export(String fileId, String mimeType) Exports a Google Workspace document to the requested MIME type and returns exported byte content.

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() The ID of the file.
String	getMimeType() Required.
Drive.Files.Export	set(String parameterName, Object value)
Drive.Files.Export	set$Xgafv(String $Xgafv) V1 error format.
Drive.Files.Export	setAccessToken(String accessToken) OAuth access token.
Drive.Files.Export	setAlt(String alt) Data format for response.
Drive.Files.Export	setCallback(String callback) JSONP
Drive.Files.Export	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Export	setFileId(String fileId) The ID of the file.
Drive.Files.Export	setKey(String key) API key.
Drive.Files.Export	setMimeType(String mimeType) Required.
Drive.Files.Export	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Export	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Export	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Files.Export	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Drive.Files.Export	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, 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

Export

protected Export(String fileId,
                 String mimeType)

Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB. Create a request for the method "files.export". 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 - The ID of the file.

mimeType - Required. The MIME type of the format requested for this export.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:

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

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

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

Throws:

IOException

executeMedia

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

Overrides:

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

Throws:

IOException

buildHttpRequestUrl

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

Overrides:

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

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

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

Description copied from class: DriveRequest

V1 error format.

Overrides:

set$Xgafv in class DriveRequest<Void>

setAccessToken

public Drive.Files.Export setAccessToken(String accessToken)

Description copied from class: DriveRequest

OAuth access token.

Overrides:

setAccessToken in class DriveRequest<Void>

setAlt

public Drive.Files.Export setAlt(String alt)

Description copied from class: DriveRequest

Data format for response.

Overrides:

setAlt in class DriveRequest<Void>

setCallback

public Drive.Files.Export setCallback(String callback)

Description copied from class: DriveRequest

JSONP

Overrides:

setCallback in class DriveRequest<Void>

setFields

public Drive.Files.Export setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<Void>

setKey

public Drive.Files.Export 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<Void>

setOauthToken

public Drive.Files.Export setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<Void>

setPrettyPrint

public Drive.Files.Export setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<Void>

setQuotaUser

public Drive.Files.Export 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<Void>

setUploadType

public Drive.Files.Export setUploadType(String uploadType)

Description copied from class: DriveRequest

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

Overrides:

setUploadType in class DriveRequest<Void>

setUploadProtocol

public Drive.Files.Export setUploadProtocol(String uploadProtocol)

Description copied from class: DriveRequest

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

Overrides:

setUploadProtocol in class DriveRequest<Void>

getFileId

public String getFileId()

The ID of the file.

setFileId

public Drive.Files.Export setFileId(String fileId)

The ID of the file.

getMimeType

public String getMimeType()

Required. The MIME type of the format requested for this export.

setMimeType

public Drive.Files.Export setMimeType(String mimeType)

Required. The MIME type of the format requested for this export.

set

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

Overrides:

set in class DriveRequest<Void>