Drive API v2 (revision 47)



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

java.lang.Object
  extended by java.util.AbstractMap<java.lang.String,java.lang.Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
              extended by com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  extended by com.google.api.services.drive.DriveRequest<File>
                      extended by com.google.api.services.drive.Drive.Files.Patch
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
Enclosing class:
Drive.Files

public class Drive.Files.Patch
extends DriveRequest<File>


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
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>
 
Method Summary
 java.lang.Boolean getConvert()
          Whether to convert this file to the corresponding Google Docs format.
 java.lang.String getFileId()
          The ID of the file to update.
 java.lang.Boolean getNewRevision()
          Whether a blob upload should create a new revision.
 java.lang.Boolean getOcr()
          Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
 java.lang.String getOcrLanguage()
          If ocr is true, hints at the language to use.
 java.lang.Boolean getPinned()
          Whether to pin the new revision.
 java.lang.Boolean getSetModifiedDate()
          Whether to set the modified date with the supplied modified date.
 java.lang.String getTimedTextLanguage()
          The language of the timed text.
 java.lang.String getTimedTextTrackName()
          The timed text track name.
 java.lang.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.
 Drive.Files.Patch setAlt(java.lang.String alt)
          Data format for the response.
 Drive.Files.Patch setConvert(java.lang.Boolean convert)
          Whether to convert this file to the corresponding Google Docs format.
 Drive.Files.Patch setFields(java.lang.String fields)
          Selector specifying which fields to include in a partial response.
 Drive.Files.Patch setFileId(java.lang.String fileId)
          The ID of the file to update.
 Drive.Files.Patch setKey(java.lang.String key)
          API key.
 Drive.Files.Patch setNewRevision(java.lang.Boolean newRevision)
          Whether a blob upload should create a new revision.
 Drive.Files.Patch setOauthToken(java.lang.String oauthToken)
          OAuth 2.0 token for the current user.
 Drive.Files.Patch setOcr(java.lang.Boolean ocr)
          Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
 Drive.Files.Patch setOcrLanguage(java.lang.String ocrLanguage)
          If ocr is true, hints at the language to use.
 Drive.Files.Patch setPinned(java.lang.Boolean pinned)
          Whether to pin the new revision.
 Drive.Files.Patch setPrettyPrint(java.lang.Boolean prettyPrint)
          Returns response with indentations and line breaks.
 Drive.Files.Patch setQuotaUser(java.lang.String quotaUser)
          Available to use for quota purposes for server-side applications.
 Drive.Files.Patch setSetModifiedDate(java.lang.Boolean setModifiedDate)
          Whether to set the modified date with the supplied modified date.
 Drive.Files.Patch setTimedTextLanguage(java.lang.String timedTextLanguage)
          The language of the timed text.
 Drive.Files.Patch setTimedTextTrackName(java.lang.String timedTextTrackName)
          The timed text track name.
 Drive.Files.Patch setUpdateViewedDate(java.lang.Boolean updateViewedDate)
          Whether to update the view date after successfully updating the file.
 Drive.Files.Patch 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, buildHttpRequestUsingHead, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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, 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

setAlt

public Drive.Files.Patch setAlt(java.lang.String alt)
Description copied from class: DriveRequest
Data format for the response.

Overrides:
setAlt in class DriveRequest<File>

setFields

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

setKey

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

setOauthToken

public Drive.Files.Patch setOauthToken(java.lang.String oauthToken)
Description copied from class: DriveRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class DriveRequest<File>

setPrettyPrint

public Drive.Files.Patch setPrettyPrint(java.lang.Boolean prettyPrint)
Description copied from class: DriveRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class DriveRequest<File>

setQuotaUser

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

setUserIp

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

getFileId

public java.lang.String getFileId()
The ID of the file to update.


setFileId

public Drive.Files.Patch setFileId(java.lang.String fileId)
The ID of the file to update.


getConvert

public java.lang.Boolean getConvert()
Whether to convert this file to the corresponding Google Docs format. [default: false]


setConvert

public Drive.Files.Patch setConvert(java.lang.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.


getUpdateViewedDate

public java.lang.Boolean getUpdateViewedDate()
Whether to update the view date after successfully updating the file. [default: true]


setUpdateViewedDate

public Drive.Files.Patch setUpdateViewedDate(java.lang.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.


getSetModifiedDate

public java.lang.Boolean getSetModifiedDate()
Whether to set the modified date with the supplied modified date. [default: false]


setSetModifiedDate

public Drive.Files.Patch setSetModifiedDate(java.lang.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.


getOcrLanguage

public java.lang.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(java.lang.String ocrLanguage)
If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.


getPinned

public java.lang.Boolean getPinned()
Whether to pin the new revision. [default: false]


setPinned

public Drive.Files.Patch setPinned(java.lang.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 java.lang.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(java.lang.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 java.lang.Boolean getOcr()
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. [default: false]


setOcr

public Drive.Files.Patch setOcr(java.lang.Boolean ocr)
Whether to attempt OCR on .jpg, .png, .gif, or .pdf 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, .gif, or .pdf uploads.


getTimedTextLanguage

public java.lang.String getTimedTextLanguage()
The language of the timed text.


setTimedTextLanguage

public Drive.Files.Patch setTimedTextLanguage(java.lang.String timedTextLanguage)
The language of the timed text.


getTimedTextTrackName

public java.lang.String getTimedTextTrackName()
The timed text track name.


setTimedTextTrackName

public Drive.Files.Patch setTimedTextTrackName(java.lang.String timedTextTrackName)
The timed text track name.