target.apidocs.com.google.api.services.drive.Drive.Files.Update.html Maven / Gradle / Ivy
Drive.Files.Update (Google Drive API v3-rev20240123-2.0.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 a file's metadata and/or content.
protected
Update(String fileId,
File content,
com.google.api.client.http.AbstractInputStreamContent mediaContent)
Updates a file's metadata and/or content.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getAddParents()
A comma-separated list of parent IDs to add.
Boolean
getEnforceSingleParent()
Deprecated: Adding files to multiple folders is no longer supported.
String
getFileId()
The ID of the file.
String
getIncludeLabels()
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
String
getIncludePermissionsForView()
Specifies which additional view's permissions to include in the response.
Boolean
getKeepRevisionForever()
Whether to set the 'keepForever' field in the new head revision.
String
getOcrLanguage()
A language hint for OCR processing during image import (ISO 639-1 code).
String
getRemoveParents()
A comma-separated list of parent IDs to remove.
Boolean
getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives.
Boolean
getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead.
Boolean
getUseContentAsIndexableText()
Whether to use the uploaded content as indexable text.
boolean
isEnforceSingleParent()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isKeepRevisionForever()
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
isUseContentAsIndexableText()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
Drive.Files.Update
set(String parameterName,
Object value)
Drive.Files.Update
set$Xgafv(String $Xgafv)
V1 error format.
Drive.Files.Update
setAccessToken(String accessToken)
OAuth access token.
Drive.Files.Update
setAddParents(String addParents)
A comma-separated list of parent IDs to add.
Drive.Files.Update
setAlt(String alt)
Data format for response.
Drive.Files.Update
setCallback(String callback)
JSONP
Drive.Files.Update
setEnforceSingleParent(Boolean enforceSingleParent)
Deprecated: Adding files to multiple folders is no longer supported.
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.
Drive.Files.Update
setIncludeLabels(String includeLabels)
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
Drive.Files.Update
setIncludePermissionsForView(String includePermissionsForView)
Specifies which additional view's permissions to include in the response.
Drive.Files.Update
setKeepRevisionForever(Boolean keepRevisionForever)
Whether to set the 'keepForever' field in the new head revision.
Drive.Files.Update
setKey(String key)
API key.
Drive.Files.Update
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Drive.Files.Update
setOcrLanguage(String ocrLanguage)
A language hint for OCR processing during image import (ISO 639-1 code).
Drive.Files.Update
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Drive.Files.Update
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Drive.Files.Update
setRemoveParents(String removeParents)
A comma-separated list of parent IDs to remove.
Drive.Files.Update
setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and shared drives.
Drive.Files.Update
setSupportsTeamDrives(Boolean supportsTeamDrives)
Deprecated: Use `supportsAllDrives` instead.
Drive.Files.Update
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Drive.Files.Update
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Drive.Files.Update
setUseContentAsIndexableText(Boolean useContentAsIndexableText)
Whether to use the uploaded content as indexable text.
-
Methods inherited from class com.google.api.services.drive.DriveRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, 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 a file's metadata and/or content. When calling this method, only populate fields in the
request that you want to modify. When updating fields, some fields might be changed
automatically, such as `modifiedDate`. This method supports patch semantics. This method
supports an upload* URI and accepts uploaded media with the following characteristics: -
*Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*` Note: Specify a valid MIME
type, rather than the literal `*` value. The literal `*` is only used to indicate that any
valid MIME type can be uploaded. For more information on uploading files, see [Upload file
data](/drive/api/guides/manage-uploads).
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.
content
- the File
- Since:
- 1.13
-
Update
protected Update(String fileId,
File content,
com.google.api.client.http.AbstractInputStreamContent mediaContent)
Updates a file's metadata and/or content. When calling this method, only populate fields in the
request that you want to modify. When updating fields, some fields might be changed
automatically, such as `modifiedDate`. This method supports patch semantics. This method
supports an upload* URI and accepts uploaded media with the following characteristics: -
*Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*` Note: Specify a valid MIME
type, rather than the literal `*` value. The literal `*` is only used to indicate that any
valid MIME type can be uploaded. For more information on uploading files, see [Upload file
data](/drive/api/guides/manage-uploads).
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.
content
- the File
media metadata or null
if none
mediaContent
- The media HTTP content.
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Drive.Files.Update set$Xgafv(String $Xgafv)
Description copied from class: DriveRequest
V1 error format.
- Overrides:
set$Xgafv
in class DriveRequest<File>
-
setAccessToken
public Drive.Files.Update setAccessToken(String accessToken)
Description copied from class: DriveRequest
OAuth access token.
- Overrides:
setAccessToken
in class DriveRequest<File>
-
setAlt
public Drive.Files.Update setAlt(String alt)
Description copied from class: DriveRequest
Data format for response.
- Overrides:
setAlt
in class DriveRequest<File>
-
setCallback
public Drive.Files.Update setCallback(String callback)
Description copied from class: DriveRequest
JSONP
- Overrides:
setCallback
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
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:
setQuotaUser
in class DriveRequest<File>
-
setUploadType
public Drive.Files.Update setUploadType(String uploadType)
Description copied from class: DriveRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class DriveRequest<File>
-
setUploadProtocol
public Drive.Files.Update setUploadProtocol(String uploadProtocol)
Description copied from class: DriveRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class DriveRequest<File>
-
getFileId
public String getFileId()
The ID of the file.
-
setFileId
public Drive.Files.Update setFileId(String fileId)
The ID of the file.
-
getAddParents
public String getAddParents()
A comma-separated list of parent IDs to add.
-
setAddParents
public Drive.Files.Update setAddParents(String addParents)
A comma-separated list of parent IDs to add.
-
getEnforceSingleParent
public Boolean getEnforceSingleParent()
Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
[default: false]
-
setEnforceSingleParent
public Drive.Files.Update setEnforceSingleParent(Boolean enforceSingleParent)
Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
-
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
.
Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
-
getIncludeLabels
public String getIncludeLabels()
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
-
setIncludeLabels
public Drive.Files.Update setIncludeLabels(String includeLabels)
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
-
getIncludePermissionsForView
public String getIncludePermissionsForView()
Specifies which additional view's permissions to include in the response. Only 'published' is
supported.
-
setIncludePermissionsForView
public Drive.Files.Update setIncludePermissionsForView(String includePermissionsForView)
Specifies which additional view's permissions to include in the response. Only 'published'
is supported.
-
getKeepRevisionForever
public Boolean getKeepRevisionForever()
Whether to set the 'keepForever' field in the new head revision. This is only applicable to files
with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the
limit is reached, try deleting pinned revisions. [default: false]
-
setKeepRevisionForever
public Drive.Files.Update setKeepRevisionForever(Boolean keepRevisionForever)
Whether to set the 'keepForever' field in the new head revision. This is only applicable to
files with binary content in Google Drive. Only 200 revisions for the file can be kept
forever. If the limit is reached, try deleting pinned revisions.
-
isKeepRevisionForever
public boolean isKeepRevisionForever()
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 'keepForever' field in the new head revision. This is only applicable to files
with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the
limit is reached, try deleting pinned revisions.
-
getOcrLanguage
public String getOcrLanguage()
A language hint for OCR processing during image import (ISO 639-1 code).
-
setOcrLanguage
public Drive.Files.Update setOcrLanguage(String ocrLanguage)
A language hint for OCR processing during image import (ISO 639-1 code).
-
getRemoveParents
public String getRemoveParents()
A comma-separated list of parent IDs to remove.
-
setRemoveParents
public Drive.Files.Update setRemoveParents(String removeParents)
A comma-separated list of parent IDs to remove.
-
getSupportsAllDrives
public Boolean getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives. [default: false]
-
setSupportsAllDrives
public Drive.Files.Update setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and 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
.
Whether the requesting application supports both My Drives and shared drives.
-
getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead. [default: false]
-
setSupportsTeamDrives
public Drive.Files.Update setSupportsTeamDrives(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.
-
getUseContentAsIndexableText
public Boolean getUseContentAsIndexableText()
Whether to use the uploaded content as indexable text. [default: false]
-
setUseContentAsIndexableText
public Drive.Files.Update setUseContentAsIndexableText(Boolean useContentAsIndexableText)
Whether to use the uploaded 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 uploaded content as indexable text.
-
set
public Drive.Files.Update set(String parameterName,
Object value)
- Overrides:
set
in class DriveRequest<File>
Copyright © 2011–2024 Google. All rights reserved.