com.google.api.services.drive

Class Drive.Files.Export

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.drive.DriveRequest<java.lang.Void>

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

All Implemented Interfaces:

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

Enclosing class:

Drive.Files

public class Drive.Files.Export
extends DriveRequest<java.lang.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

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	Drive.Files.Export(java.lang.String fileId, java.lang.String mimeType) Exports a Google Doc to the requested MIME type and returns the exported content.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(java.io.OutputStream outputStream)
java.io.InputStream	executeMediaAsInputStream()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getFileId() The ID of the file.
java.lang.String	getMimeType() The MIME type of the format requested for this export.
Drive.Files.Export	set(java.lang.String parameterName, java.lang.Object value)
Drive.Files.Export	setAlt(java.lang.String alt) Data format for the response.
Drive.Files.Export	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Export	setFileId(java.lang.String fileId) The ID of the file.
Drive.Files.Export	setKey(java.lang.String key) API key.
Drive.Files.Export	setMimeType(java.lang.String mimeType) The MIME type of the format requested for this export.
Drive.Files.Export	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Export	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Export	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Files.Export	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeUnparsed, 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

Constructor Detail

Drive.Files.Export

protected Drive.Files.Export(java.lang.String fileId,
                  java.lang.String mimeType)

Exports a Google Doc to the requested MIME type and returns the exported content. Please 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 - The MIME type of the format requested for this export.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(java.io.OutputStream outputStream)
                               throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

executeMediaAsInputStream

public java.io.InputStream executeMediaAsInputStream()
                                              throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

executeMedia

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

Overrides:

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

Throws:

java.io.IOException

executeUsingHead

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

Overrides:

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

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

java.io.IOException

setAlt

public Drive.Files.Export setAlt(java.lang.String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<java.lang.Void>

setFields

public Drive.Files.Export setFields(java.lang.String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<java.lang.Void>

setKey

public Drive.Files.Export setKey(java.lang.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<java.lang.Void>

setOauthToken

public Drive.Files.Export setOauthToken(java.lang.String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<java.lang.Void>

setPrettyPrint

public Drive.Files.Export setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<java.lang.Void>

setQuotaUser

public Drive.Files.Export setQuotaUser(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<java.lang.Void>

setUserIp

public Drive.Files.Export setUserIp(java.lang.String userIp)

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<java.lang.Void>

getFileId

public java.lang.String getFileId()

The ID of the file.

setFileId

public Drive.Files.Export setFileId(java.lang.String fileId)

The ID of the file.

getMimeType

public java.lang.String getMimeType()

The MIME type of the format requested for this export.

setMimeType

public Drive.Files.Export setMimeType(java.lang.String mimeType)

The MIME type of the format requested for this export.

set

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

Overrides:

set in class DriveRequest<java.lang.Void>