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.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.drive.DriveRequest<File>

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

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Drive.Files.Patch(String fileId, File content) Updates file metadata and/or content.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAddParents() Comma-separated list of parent IDs to add.
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, .gif, or .pdf uploads.
String	getOcrLanguage() If ocr is true, hints at the language to use.
Boolean	getPinned() Whether to pin the new revision.
String	getRemoveParents() Comma-separated list of parent IDs to remove.
Boolean	getSetModifiedDate() Whether to set the modified date with the supplied modified date.
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	getUseContentAsIndexableText() Whether to use the content as indexable text.
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.
boolean	isUseContentAsIndexableText() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Files.Patch	set(String parameterName, Object value)
Drive.Files.Patch	setAddParents(String addParents) Comma-separated list of parent IDs to add.
Drive.Files.Patch	setAlt(String alt) Data format for the response.
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	setKey(String key) API key.
Drive.Files.Patch	setNewRevision(Boolean newRevision) Whether a blob upload should create a new revision.
Drive.Files.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Patch	setOcr(Boolean ocr) Whether to attempt OCR on .jpg, .png, .gif, or .pdf 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	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Files.Patch	setRemoveParents(String removeParents) Comma-separated list of parent IDs to remove.
Drive.Files.Patch	setSetModifiedDate(Boolean setModifiedDate) Whether to set the modified date with the supplied modified date.
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.
Drive.Files.Patch	setUseContentAsIndexableText(Boolean useContentAsIndexableText) Whether to use the content as indexable text.
Drive.Files.Patch	setUserIp(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, checkRequiredParameter, 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, 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.Patch

protected Drive.Files.Patch(String fileId,
                 File content)

Updates file metadata and/or content. This method supports patch semantics. Create a request for the method "files.patch". 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 to update.

content - the File

Since:

1.13

Method Detail

setAlt

public Drive.Files.Patch setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<File>

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

setKey

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

setOauthToken

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

The ID of the file to update.

setFileId

public Drive.Files.Patch setFileId(String fileId)

The ID of the file to update.

getAddParents

public String getAddParents()

Comma-separated list of parent IDs to add.

setAddParents

public Drive.Files.Patch setAddParents(String addParents)

Comma-separated list of parent IDs to add.

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.

getRemoveParents

public String getRemoveParents()

Comma-separated list of parent IDs to remove.

setRemoveParents

public Drive.Files.Patch setRemoveParents(String removeParents)

Comma-separated list of parent IDs to remove.

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.

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.

getUseContentAsIndexableText

public Boolean getUseContentAsIndexableText()

Whether to use the content as indexable text. [default: false]

setUseContentAsIndexableText

public Drive.Files.Patch setUseContentAsIndexableText(Boolean useContentAsIndexableText)

Whether to use the content as indexable text.

isUseContentAsIndexableText

public boolean isUseContentAsIndexableText()

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 use the content as indexable text.

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. A file can have a maximum of 200 pinned revisions. [default: false]

setPinned

public Drive.Files.Patch setPinned(Boolean pinned)

Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.

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. A file can have a maximum of 200 pinned revisions.

getNewRevision

public Boolean getNewRevision()

Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota). [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 is replaced. If true or not set, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota).

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 is replaced. If true or not set, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota).

getOcr

public Boolean getOcr()

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

setOcr

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

set

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

Overrides:

set in class DriveRequest<File>