target.apidocs.com.google.api.services.drive.Drive.Files.Update.html Maven / Gradle / Ivy
Drive.Files.Update (Drive API v2-rev20180830-1.26.0)
com.google.api.services.drive
Class Drive.Files.Update
- 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.Update
-
- 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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Update(String fileId,
File content)
Updates file metadata and/or content.
protected
Update(String fileId,
File content,
com.google.api.client.http.AbstractInputStreamContent mediaContent)
Updates file metadata and/or content.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getAddParents()
Comma-separated list of parent IDs to add.
Boolean
getConvert()
This parameter is deprecated and has no function.
String
getFileId()
The ID of the file to update.
String
getModifiedDateBehavior()
Determines the behavior in which modifiedDate is updated.
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 using the value supplied in the request body.
Boolean
getSupportsTeamDrives()
Whether the requesting application supports Team Drives.
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
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(String parameterName,
Object value)
Drive.Files.Update
setAddParents(String addParents)
Comma-separated list of parent IDs to add.
Drive.Files.Update
setAlt(String alt)
Data format for the response.
Drive.Files.Update
setConvert(Boolean convert)
This parameter is deprecated and has no function.
Drive.Files.Update
setFields(String fields)
Selector specifying which fields to include in a partial response.
Drive.Files.Update
setFileId(String fileId)
The ID of the file to update.
Drive.Files.Update
setKey(String key)
API key.
Drive.Files.Update
setModifiedDateBehavior(String modifiedDateBehavior)
Determines the behavior in which modifiedDate is updated.
Drive.Files.Update
setNewRevision(Boolean newRevision)
Whether a blob upload should create a new revision.
Drive.Files.Update
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Drive.Files.Update
setOcr(Boolean ocr)
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Drive.Files.Update
setOcrLanguage(String ocrLanguage)
If ocr is true, hints at the language to use.
Drive.Files.Update
setPinned(Boolean pinned)
Whether to pin the new revision.
Drive.Files.Update
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Drive.Files.Update
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Drive.Files.Update
setRemoveParents(String removeParents)
Comma-separated list of parent IDs to remove.
Drive.Files.Update
setSetModifiedDate(Boolean setModifiedDate)
Whether to set the modified date using the value supplied in the request body.
Drive.Files.Update
setSupportsTeamDrives(Boolean supportsTeamDrives)
Whether the requesting application supports Team Drives.
Drive.Files.Update
setTimedTextLanguage(String timedTextLanguage)
The language of the timed text.
Drive.Files.Update
setTimedTextTrackName(String timedTextTrackName)
The timed text track name.
Drive.Files.Update
setUpdateViewedDate(Boolean updateViewedDate)
Whether to update the view date after successfully updating the file.
Drive.Files.Update
setUseContentAsIndexableText(Boolean useContentAsIndexableText)
Whether to use the content as indexable text.
Drive.Files.Update
setUserIp(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(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(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(String alt)
Description copied from class: DriveRequest
Data format for the response.
- Overrides:
setAlt
in class DriveRequest<File>
-
setFields
public Drive.Files.Update 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.Update 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.Update 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.Update 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.Update setQuotaUser(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(String userIp)
Description copied from class: DriveRequest
Deprecated. Please use quotaUser instead.
- Overrides:
setUserIp
in class DriveRequest<File>
-
getFileId
public String getFileId()
The ID of the file to update.
-
setFileId
public Drive.Files.Update 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.Update setAddParents(String addParents)
Comma-separated list of parent IDs to add.
-
getConvert
public Boolean getConvert()
This parameter is deprecated and has no function. [default: false]
-
setConvert
public Drive.Files.Update setConvert(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.
-
getModifiedDateBehavior
public String getModifiedDateBehavior()
Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
-
setModifiedDateBehavior
public Drive.Files.Update setModifiedDateBehavior(String modifiedDateBehavior)
Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
-
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
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(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 Boolean getOcr()
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. [default: false]
-
setOcr
public Drive.Files.Update 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.
-
getOcrLanguage
public String getOcrLanguage()
If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
-
setOcrLanguage
public Drive.Files.Update setOcrLanguage(String ocrLanguage)
If ocr is true, hints at the language to use. Valid values are BCP 47 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.Update 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.
-
getRemoveParents
public String getRemoveParents()
Comma-separated list of parent IDs to remove.
-
setRemoveParents
public Drive.Files.Update setRemoveParents(String removeParents)
Comma-separated list of parent IDs to remove.
-
getSetModifiedDate
public 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(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.
-
getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Whether the requesting application supports Team Drives. [default: false]
-
setSupportsTeamDrives
public Drive.Files.Update setSupportsTeamDrives(Boolean supportsTeamDrives)
Whether the requesting application supports Team Drives.
-
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
.
Whether the requesting application supports Team Drives.
-
getTimedTextLanguage
public String getTimedTextLanguage()
The language of the timed text.
-
setTimedTextLanguage
public Drive.Files.Update setTimedTextLanguage(String timedTextLanguage)
The language of the timed text.
-
getTimedTextTrackName
public String getTimedTextTrackName()
The timed text track name.
-
setTimedTextTrackName
public Drive.Files.Update setTimedTextTrackName(String timedTextTrackName)
The timed text track name.
-
getUpdateViewedDate
public Boolean getUpdateViewedDate()
Whether to update the view date after successfully updating the file. [default: true]
-
setUpdateViewedDate
public Drive.Files.Update 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.
-
getUseContentAsIndexableText
public Boolean getUseContentAsIndexableText()
Whether to use the content as indexable text. [default: false]
-
setUseContentAsIndexableText
public Drive.Files.Update 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.
-
set
public Drive.Files.Update set(String parameterName,
Object value)
- Overrides:
set
in class DriveRequest<File>
Copyright © 2011–2018 Google. All rights reserved.