Drive API v2 (revision 1)

com.google.api.services.drive
Class Drive.Files.Insert

java.lang.Object
  java.util.AbstractMap<String,Object>
      com.google.api.client.util.GenericData
          com.google.api.client.http.json.JsonHttpRequest
              com.google.api.services.drive.DriveRequest
                  com.google.api.services.drive.Drive.Files.Insert

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.Insert
extends DriveRequest

Nested Class Summary

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

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>

Method Summary

HttpRequest	buildHttpRequest()
File	execute() Sends the "insert" request to the Drive server.
HttpResponse	executeUnparsed()
Boolean	getConvert() Whether to convert this file to the corresponding Google Docs format.
MediaHttpUploader	getMediaHttpUploader() Returns the Media HTTP Uploader or null if there is no media HTTP content provided to be uploaded.
Boolean	getOcr() Whether to attempt OCR on .jpg, .png, or .gif uploads.
String	getOcrLanguage() If ocr is true, hints at the language to use.
Boolean	getPinned() Whether to pin the head revision of the uploaded file.
String	getSourceLanguage() The language of the original file to be translated.
String	getTargetLanguage() Target language to translate the file to.
String	getTimedTextLanguage() The language of the timed text.
String	getTimedTextTrackName() The timed text track name.
boolean	isConvert() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isOcr() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isPinned() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
void	queue(BatchRequest batch, JsonBatchCallback<File> callback) Queues the "insert" request to the Drive server into the given batch request.
Drive.Files.Insert	setConvert(Boolean convert) Whether to convert this file to the corresponding Google Docs format.
Drive.Files.Insert	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Insert	setOcr(Boolean ocr) Whether to attempt OCR on .jpg, .png, or .gif uploads.
Drive.Files.Insert	setOcrLanguage(String ocrLanguage) If ocr is true, hints at the language to use.
Drive.Files.Insert	setPinned(Boolean pinned) Whether to pin the head revision of the uploaded file.
Drive.Files.Insert	setSourceLanguage(String sourceLanguage) The language of the original file to be translated.
Drive.Files.Insert	setTargetLanguage(String targetLanguage) Target language to translate the file to.
Drive.Files.Insert	setTimedTextLanguage(String timedTextLanguage) The language of the timed text.
Drive.Files.Insert	setTimedTextTrackName(String timedTextTrackName) The timed text track name.

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

getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setAlt, setKey, setOauthToken, setPrettyPrint, setQuotaUser, setUserIp

Methods inherited from class com.google.api.client.http.json.JsonHttpRequest

buildHttpRequestUrl, download, executeAsInputStream, getClient, getEnableGZipContent, getJsonContent, getLastResponseHeaders, getMethod, getRequestHeaders, getUriTemplate, setEnableGZipContent, setRequestHeaders

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, 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

Method Detail

executeUnparsed

public HttpResponse executeUnparsed()
                             throws IOException

Overrides:

executeUnparsed in class JsonHttpRequest

Throws:

IOException

buildHttpRequest

public HttpRequest buildHttpRequest()
                             throws IOException

Overrides:

buildHttpRequest in class JsonHttpRequest

Throws:

IOException

execute

public File execute()
             throws IOException

Sends the "insert" request to the Drive server.

Returns:

the File response

Throws:

IOException - if the request fails

queue

public void queue(BatchRequest batch,
                  JsonBatchCallback<File> callback)
           throws IOException

Queues the "insert" request to the Drive server into the given batch request.

Example usage:

         request.queue(batchRequest, new JsonBatchCallback<File>() {

           public void onSuccess(File content, GoogleHeaders responseHeaders) {
             log("Success");
           }

           public void onFailure(GoogleJsonError e, GoogleHeaders responseHeaders) {
             log(e.getMessage());
           }
         });
 

Parameters:

batch - a single batch of requests

callback - batch callback

Throws:

IOException

Since:

1.6

setFields

public Drive.Files.Insert setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest

Since:

1.7

getConvert

public Boolean getConvert()

Whether to convert this file to the corresponding Google Docs format. [default: false]

setConvert

public Drive.Files.Insert setConvert(Boolean convert)

Whether to convert this file to the corresponding Google Docs format.

isConvert

public boolean isConvert()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether to convert this file to the corresponding Google Docs format.

getTargetLanguage

public String getTargetLanguage()

Target language to translate the file to. If no sourceLanguage is provided, the API will attempt to detect the language.

setTargetLanguage

public Drive.Files.Insert setTargetLanguage(String targetLanguage)

Target language to translate the file to. If no sourceLanguage is provided, the API will attempt to detect the language.

getSourceLanguage

public String getSourceLanguage()

The language of the original file to be translated.

setSourceLanguage

public Drive.Files.Insert setSourceLanguage(String sourceLanguage)

The language of the original file to be translated.

getOcrLanguage

public String getOcrLanguage()

If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.

setOcrLanguage

public Drive.Files.Insert setOcrLanguage(String ocrLanguage)

If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.

getPinned

public Boolean getPinned()

Whether to pin the head revision of the uploaded file. [default: false]

setPinned

public Drive.Files.Insert setPinned(Boolean pinned)

Whether to pin the head revision of the uploaded file.

isPinned

public boolean isPinned()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether to pin the head revision of the uploaded file.

getOcr

public Boolean getOcr()

Whether to attempt OCR on .jpg, .png, or .gif uploads. [default: false]

setOcr

public Drive.Files.Insert setOcr(Boolean ocr)

Whether to attempt OCR on .jpg, .png, or .gif uploads.

isOcr

public boolean isOcr()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether to attempt OCR on .jpg, .png, or .gif uploads.

getTimedTextTrackName

public String getTimedTextTrackName()

The timed text track name.

setTimedTextTrackName

public Drive.Files.Insert setTimedTextTrackName(String timedTextTrackName)

The timed text track name.

getTimedTextLanguage

public String getTimedTextLanguage()

The language of the timed text.

setTimedTextLanguage

public Drive.Files.Insert setTimedTextLanguage(String timedTextLanguage)

The language of the timed text.

getMediaHttpUploader

public MediaHttpUploader getMediaHttpUploader()

Returns the Media HTTP Uploader or null if there is no media HTTP content provided to be uploaded.