Drive API v2 (revision 1)

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

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.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.Patch
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

File	execute() Sends the "patch" request to the Drive server.
Boolean	getConvert() Whether to convert this file to the corresponding Google Docs format.
String	getFileId() The ID of the file to update.
Boolean	getNewRevision() Whether a blob upload should create a new revision.
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 new revision.
Boolean	getSetModifiedDate() Whether to set the modified date with the supplied modified date.
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	getUpdateViewedDate() Whether to update the view date after successfully updating the file.
boolean	isConvert() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isNewRevision() 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.
boolean	isSetModifiedDate() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isUpdateViewedDate() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
void	queue(BatchRequest batch, JsonBatchCallback<File> callback) Queues the "patch" request to the Drive server into the given batch request.
Drive.Files.Patch	setConvert(Boolean convert) Whether to convert this file to the corresponding Google Docs format.
Drive.Files.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Patch	setFileId(String fileId) The ID of the file to update.
Drive.Files.Patch	setNewRevision(Boolean newRevision) Whether a blob upload should create a new revision.
Drive.Files.Patch	setOcr(Boolean ocr) Whether to attempt OCR on .jpg, .png, or .gif uploads.
Drive.Files.Patch	setOcrLanguage(String ocrLanguage) If ocr is true, hints at the language to use.
Drive.Files.Patch	setPinned(Boolean pinned) Whether to pin the new revision.
Drive.Files.Patch	setSetModifiedDate(Boolean setModifiedDate) Whether to set the modified date with the supplied modified date.
Drive.Files.Patch	setSourceLanguage(String sourceLanguage) The language of the original file to be translated.
Drive.Files.Patch	setTargetLanguage(String targetLanguage) Target language to translate the file to.
Drive.Files.Patch	setTimedTextLanguage(String timedTextLanguage) The language of the timed text.
Drive.Files.Patch	setTimedTextTrackName(String timedTextTrackName) The timed text track name.
Drive.Files.Patch	setUpdateViewedDate(Boolean updateViewedDate) Whether to update the view date after successfully updating the file.

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

buildHttpRequest, buildHttpRequestUrl, download, executeAsInputStream, executeUnparsed, 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

execute

public File execute()
             throws IOException

Sends the "patch" 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 "patch" 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.Patch 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

getFileId

public String getFileId()

The ID of the file to update.

setFileId

public Drive.Files.Patch setFileId(String fileId)

The ID of the file to update.

getConvert

public Boolean getConvert()

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

setConvert

public Drive.Files.Patch 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.Patch setTargetLanguage(String targetLanguage)

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

getSetModifiedDate

public Boolean getSetModifiedDate()

Whether to set the modified date with the supplied modified date. [default: false]

setSetModifiedDate

public Drive.Files.Patch setSetModifiedDate(Boolean setModifiedDate)

Whether to set the modified date with the supplied modified date.

isSetModifiedDate

public boolean isSetModifiedDate()

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 set the modified date with the supplied modified date.

getUpdateViewedDate

public Boolean getUpdateViewedDate()

Whether to update the view date after successfully updating the file. [default: true]

setUpdateViewedDate

public Drive.Files.Patch setUpdateViewedDate(Boolean updateViewedDate)

Whether to update the view date after successfully updating the file.

isUpdateViewedDate

public boolean isUpdateViewedDate()

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 update the view date after successfully updating the file.

getSourceLanguage

public String getSourceLanguage()

The language of the original file to be translated.

setSourceLanguage

public Drive.Files.Patch 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.Patch 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 new revision. [default: false]

setPinned

public Drive.Files.Patch setPinned(Boolean pinned)

Whether to pin the new revision.

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 new revision.

getNewRevision

public Boolean getNewRevision()

Whether a blob upload should create a new revision. If false, the blob data in the current head revision will be replaced. [default: true]

setNewRevision

public Drive.Files.Patch setNewRevision(Boolean newRevision)

Whether a blob upload should create a new revision. If false, the blob data in the current head revision will be replaced.

isNewRevision

public boolean isNewRevision()

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 a blob upload should create a new revision. If false, the blob data in the current head revision will be replaced.

getOcr

public Boolean getOcr()

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

setOcr

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

getTimedTextLanguage

public String getTimedTextLanguage()

The language of the timed text.

setTimedTextLanguage

public Drive.Files.Patch setTimedTextLanguage(String timedTextLanguage)

The language of the timed text.

getTimedTextTrackName

public String getTimedTextTrackName()

The timed text track name.

setTimedTextTrackName

public Drive.Files.Patch setTimedTextTrackName(String timedTextTrackName)

The timed text track name.