com.google.api.services.drive

Class Drive.Files.Update

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

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

All Implemented Interfaces:

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

Enclosing class:

Drive.Files

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

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	Update(java.lang.String fileId, File content) Updates file metadata and/or content.
protected	Update(java.lang.String fileId, File content, com.google.api.client.http.AbstractInputStreamContent mediaContent) Updates file metadata and/or content.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddParents() Comma-separated list of parent IDs to add.
java.lang.Boolean	getConvert() This parameter is deprecated and has no function.
java.lang.Boolean	getEnforceSingleParent() Set to true to opt in to API behavior that aims for all items to have exactly one parent.
java.lang.String	getFileId() The ID of the file to update.
java.lang.String	getModifiedDateBehavior() Determines the behavior in which modifiedDate is updated.
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.String	getRemoveParents() Comma-separated list of parent IDs to remove.
java.lang.Boolean	getSetModifiedDate() Whether to set the modified date using the value supplied in the request body.
java.lang.Boolean	getSupportsAllDrives() Deprecated - Whether the requesting application supports both My Drives and shared drives.
java.lang.Boolean	getSupportsTeamDrives() Deprecated use supportsAllDrives instead.
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.
java.lang.Boolean	getUseContentAsIndexableText() Whether to use the content as indexable text.
boolean	isConvert() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isEnforceSingleParent() 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	isSupportsAllDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsTeamDrives() 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.Update	set(java.lang.String parameterName, java.lang.Object value)
Drive.Files.Update	setAddParents(java.lang.String addParents) Comma-separated list of parent IDs to add.
Drive.Files.Update	setAlt(java.lang.String alt) Data format for the response.
Drive.Files.Update	setConvert(java.lang.Boolean convert) This parameter is deprecated and has no function.
Drive.Files.Update	setEnforceSingleParent(java.lang.Boolean enforceSingleParent) Set to true to opt in to API behavior that aims for all items to have exactly one parent.
Drive.Files.Update	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Update	setFileId(java.lang.String fileId) The ID of the file to update.
Drive.Files.Update	setKey(java.lang.String key) API key.
Drive.Files.Update	setModifiedDateBehavior(java.lang.String modifiedDateBehavior) Determines the behavior in which modifiedDate is updated.
Drive.Files.Update	setNewRevision(java.lang.Boolean newRevision) Whether a blob upload should create a new revision.
Drive.Files.Update	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Update	setOcr(java.lang.Boolean ocr) Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Drive.Files.Update	setOcrLanguage(java.lang.String ocrLanguage) If ocr is true, hints at the language to use.
Drive.Files.Update	setPinned(java.lang.Boolean pinned) Whether to pin the new revision.
Drive.Files.Update	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Update	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
Drive.Files.Update	setRemoveParents(java.lang.String removeParents) Comma-separated list of parent IDs to remove.
Drive.Files.Update	setSetModifiedDate(java.lang.Boolean setModifiedDate) Whether to set the modified date using the value supplied in the request body.
Drive.Files.Update	setSupportsAllDrives(java.lang.Boolean supportsAllDrives) Deprecated - Whether the requesting application supports both My Drives and shared drives.
Drive.Files.Update	setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives) Deprecated use supportsAllDrives instead.
Drive.Files.Update	setTimedTextLanguage(java.lang.String timedTextLanguage) The language of the timed text.
Drive.Files.Update	setTimedTextTrackName(java.lang.String timedTextTrackName) The timed text track name.
Drive.Files.Update	setUpdateViewedDate(java.lang.Boolean updateViewedDate) Whether to update the view date after successfully updating the file.
Drive.Files.Update	setUseContentAsIndexableText(java.lang.Boolean useContentAsIndexableText) Whether to use the content as indexable text.
Drive.Files.Update	setUserIp(java.lang.String userIp) Deprecated.

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Update

protected Update(java.lang.String fileId,
                 File content)

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

Update

protected Update(java.lang.String fileId,
                 File content,
                 com.google.api.client.http.AbstractInputStreamContent mediaContent)

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

This constructor should be used for uploading media content.

Parameters:

fileId - The ID of the file to update.

content - the File media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

public Drive.Files.Update 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.Update 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.Update 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.Update 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.Update 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.Update setQuotaUser(java.lang.String quotaUser)

Description copied from class: DriveRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DriveRequest<File>

setUserIp

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

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<File>

getFileId

public java.lang.String getFileId()

The ID of the file to update.

setFileId

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

The ID of the file to update.

getAddParents

public java.lang.String getAddParents()

Comma-separated list of parent IDs to add.

setAddParents

public Drive.Files.Update setAddParents(java.lang.String addParents)

Comma-separated list of parent IDs to add.

getConvert

public java.lang.Boolean getConvert()

This parameter is deprecated and has no function. [default: false]

setConvert

public Drive.Files.Update setConvert(java.lang.Boolean convert)

This parameter is deprecated and has no function.

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.

This parameter is deprecated and has no function.

getEnforceSingleParent

public java.lang.Boolean getEnforceSingleParent()

Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. [default: false]

setEnforceSingleParent

public Drive.Files.Update setEnforceSingleParent(java.lang.Boolean enforceSingleParent)

Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.

isEnforceSingleParent

public boolean isEnforceSingleParent()

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.

Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.

getModifiedDateBehavior

public java.lang.String getModifiedDateBehavior()

Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

setModifiedDateBehavior

public Drive.Files.Update setModifiedDateBehavior(java.lang.String modifiedDateBehavior)

Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

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 is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. [default: true]

setNewRevision

public Drive.Files.Update setNewRevision(java.lang.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 unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.

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 unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.

getOcr

public java.lang.Boolean getOcr()

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

setOcr

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

getOcrLanguage

public java.lang.String getOcrLanguage()

If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

setOcrLanguage

public Drive.Files.Update setOcrLanguage(java.lang.String ocrLanguage)

If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

getPinned

public java.lang.Boolean getPinned()

Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. [default: false]

setPinned

public Drive.Files.Update setPinned(java.lang.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.

getRemoveParents

public java.lang.String getRemoveParents()

Comma-separated list of parent IDs to remove.

setRemoveParents

public Drive.Files.Update setRemoveParents(java.lang.String removeParents)

Comma-separated list of parent IDs to remove.

getSetModifiedDate

public java.lang.Boolean getSetModifiedDate()

Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. [default: false]

setSetModifiedDate

public Drive.Files.Update setSetModifiedDate(java.lang.Boolean setModifiedDate)

Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.

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 using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.

getSupportsAllDrives

public java.lang.Boolean getSupportsAllDrives()

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. [default: false]

setSupportsAllDrives

public Drive.Files.Update setSupportsAllDrives(java.lang.Boolean supportsAllDrives)

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

isSupportsAllDrives

public boolean isSupportsAllDrives()

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.

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

getSupportsTeamDrives

public java.lang.Boolean getSupportsTeamDrives()

Deprecated use supportsAllDrives instead. [default: false]

setSupportsTeamDrives

public Drive.Files.Update setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)

Deprecated use supportsAllDrives instead.

isSupportsTeamDrives

public boolean isSupportsTeamDrives()

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.

Deprecated use supportsAllDrives instead.

getTimedTextLanguage

public java.lang.String getTimedTextLanguage()

The language of the timed text.

setTimedTextLanguage

public Drive.Files.Update 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.Update setTimedTextTrackName(java.lang.String timedTextTrackName)

The timed text track name.

getUpdateViewedDate

public java.lang.Boolean getUpdateViewedDate()

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

setUpdateViewedDate

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

getUseContentAsIndexableText

public java.lang.Boolean getUseContentAsIndexableText()

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

setUseContentAsIndexableText

public Drive.Files.Update setUseContentAsIndexableText(java.lang.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.

set

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

Overrides:

set in class DriveRequest<File>