• Home
• com.google.apis
• google-api-services-drive
• v2-rev20180830-1.26.0
• source code
• File.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.drive.model.File.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.drive.model
Class File



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.drive.model.File













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class File
extends com.google.api.client.json.GenericJson
The metadata for a file.

 
 This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Drive API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


static class 
File.Capabilities
Capabilities the current user has on this file.



static class 
File.ImageMediaMetadata
Metadata about image media.



static class 
File.IndexableText
Indexable text attributes for the file (can only be written)



static class 
File.Labels
A group of labels for the file.



static class 
File.Thumbnail
A thumbnail for the file.



static class 
File.VideoMediaMetadata
Metadata about video media.







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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


File() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


File
clone() 


String
getAlternateLink()
A link for opening the file in a relevant Google editor or viewer.



Boolean
getAppDataContents()
Whether this file is in the Application Data folder.



Boolean
getCanComment()
Deprecated: use capabilities/canComment.



Boolean
getCanReadRevisions()
Deprecated: use capabilities/canReadRevisions.



File.Capabilities
getCapabilities()
Capabilities the current user has on this file.



Boolean
getCopyable()
Deprecated: use capabilities/canCopy.



Boolean
getCopyRequiresWriterPermission()
Whether the options to copy, print, or download this file, should be disabled for readers and
 commenters.



com.google.api.client.util.DateTime
getCreatedDate()
Create time for this file (formatted RFC 3339 timestamp).



String
getDefaultOpenWithLink()
A link to open this file with the user's default app for this file.



String
getDescription()
A short description of the file.



String
getDownloadUrl() 


Boolean
getEditable()
Deprecated: use capabilities/canEdit.



String
getEmbedLink()
A link for embedding the file.



String
getEtag()
ETag of the file.



Boolean
getExplicitlyTrashed()
Whether this file has been explicitly trashed, as opposed to recursively trashed.



Map<String,String>
getExportLinks()
Links for exporting Google Docs to specific formats.



String
getFileExtension()
The final component of fullFileExtension with trailing text that does not appear to be part of
 the extension removed.



Long
getFileSize()
The size of the file in bytes.



String
getFolderColorRgb()
Folder color as an RGB hex string if the file is a folder.



String
getFullFileExtension()
The full file extension; extracted from the title.



Boolean
getHasAugmentedPermissions()
Whether any users are granted file access directly on this file.



Boolean
getHasThumbnail()
Whether this file has a thumbnail.



String
getHeadRevisionId()
The ID of the file's head revision.



String
getIconLink()
A link to the file's icon.



String
getId()
The ID of the file.



File.ImageMediaMetadata
getImageMediaMetadata()
Metadata about image media.



File.IndexableText
getIndexableText()
Indexable text attributes for the file (can only be written)



Boolean
getIsAppAuthorized()
Whether the file was created or opened by the requesting app.



String
getKind()
The type of file.



File.Labels
getLabels()
A group of labels for the file.



User
getLastModifyingUser()
The last user to modify this file.



String
getLastModifyingUserName()
Name of the last user to modify this file.



com.google.api.client.util.DateTime
getLastViewedByMeDate()
Last time this file was viewed by the user (formatted RFC 3339 timestamp).



com.google.api.client.util.DateTime
getMarkedViewedByMeDate()
Deprecated.



String
getMd5Checksum()
An MD5 checksum for the content of this file.



String
getMimeType()
The MIME type of the file.



com.google.api.client.util.DateTime
getModifiedByMeDate()
Last time this file was modified by the user (formatted RFC 3339 timestamp).



com.google.api.client.util.DateTime
getModifiedDate()
Last time this file was modified by anyone (formatted RFC 3339 timestamp).



Map<String,String>
getOpenWithLinks()
A map of the id of each of the user's apps to a link to open this file with that app.



String
getOriginalFilename()
The original filename of the uploaded content if available, or else the original value of the
 title field.



Boolean
getOwnedByMe()
Whether the file is owned by the current user.



List<String>
getOwnerNames()
Name(s) of the owner(s) of this file.



List<User>
getOwners()
The owner(s) of this file.



List<ParentReference>
getParents()
Collection of parent folders which contain this file.



List<String>
getPermissionIds()
List of permission IDs for users with access to this file.



List<Permission>
getPermissions()
The list of permissions for users with access to this file.



List<Property>
getProperties()
The list of properties.



Long
getQuotaBytesUsed()
The number of quota bytes used by this file.



String
getSelfLink()
A link back to this file.



Boolean
getShareable()
Deprecated: use capabilities/canShare.



Boolean
getShared()
Whether the file has been shared.



com.google.api.client.util.DateTime
getSharedWithMeDate()
Time at which this file was shared with the user (formatted RFC 3339 timestamp).



User
getSharingUser()
User that shared the item with the current user, if available.



List<String>
getSpaces()
The list of spaces which contain the file.



String
getTeamDriveId()
ID of the Team Drive the file resides in.



File.Thumbnail
getThumbnail()
A thumbnail for the file.



String
getThumbnailLink()
A short-lived link to the file's thumbnail.



Long
getThumbnailVersion()
The thumbnail version for use in thumbnail cache invalidation.



String
getTitle()
The title of this file.



com.google.api.client.util.DateTime
getTrashedDate()
The time that the item was trashed (formatted RFC 3339 timestamp).



User
getTrashingUser()
If the file has been explicitly trashed, the user who trashed it.



Permission
getUserPermission()
The permissions for the authenticated user on this file.



Long
getVersion()
A monotonically increasing version number for the file.



File.VideoMediaMetadata
getVideoMediaMetadata()
Metadata about video media.



String
getWebContentLink()
A link for downloading the content of the file in a browser using cookie based authentication.



String
getWebViewLink()
A link only available on public folders for viewing their static web assets (HTML, CSS, JS,
 etc) via Google Drive's Website Hosting.



Boolean
getWritersCanShare()
Whether writers can share the document with other users.



File
set(String fieldName,
   Object value) 


File
setAlternateLink(String alternateLink)
A link for opening the file in a relevant Google editor or viewer.



File
setAppDataContents(Boolean appDataContents)
Whether this file is in the Application Data folder.



File
setCanComment(Boolean canComment)
Deprecated: use capabilities/canComment.



File
setCanReadRevisions(Boolean canReadRevisions)
Deprecated: use capabilities/canReadRevisions.



File
setCapabilities(File.Capabilities capabilities)
Capabilities the current user has on this file.



File
setCopyable(Boolean copyable)
Deprecated: use capabilities/canCopy.



File
setCopyRequiresWriterPermission(Boolean copyRequiresWriterPermission)
Whether the options to copy, print, or download this file, should be disabled for readers and
 commenters.



File
setCreatedDate(com.google.api.client.util.DateTime createdDate)
Create time for this file (formatted RFC 3339 timestamp).



File
setDefaultOpenWithLink(String defaultOpenWithLink)
A link to open this file with the user's default app for this file.



File
setDescription(String description)
A short description of the file.



File
setDownloadUrl(String downloadUrl) 


File
setEditable(Boolean editable)
Deprecated: use capabilities/canEdit.



File
setEmbedLink(String embedLink)
A link for embedding the file.



File
setEtag(String etag)
ETag of the file.



File
setExplicitlyTrashed(Boolean explicitlyTrashed)
Whether this file has been explicitly trashed, as opposed to recursively trashed.



File
setExportLinks(Map<String,String> exportLinks)
Links for exporting Google Docs to specific formats.



File
setFileExtension(String fileExtension)
The final component of fullFileExtension with trailing text that does not appear to be part of
 the extension removed.



File
setFileSize(Long fileSize)
The size of the file in bytes.



File
setFolderColorRgb(String folderColorRgb)
Folder color as an RGB hex string if the file is a folder.



File
setFullFileExtension(String fullFileExtension)
The full file extension; extracted from the title.



File
setHasAugmentedPermissions(Boolean hasAugmentedPermissions)
Whether any users are granted file access directly on this file.



File
setHasThumbnail(Boolean hasThumbnail)
Whether this file has a thumbnail.



File
setHeadRevisionId(String headRevisionId)
The ID of the file's head revision.



File
setIconLink(String iconLink)
A link to the file's icon.



File
setId(String id)
The ID of the file.



File
setImageMediaMetadata(File.ImageMediaMetadata imageMediaMetadata)
Metadata about image media.



File
setIndexableText(File.IndexableText indexableText)
Indexable text attributes for the file (can only be written)



File
setIsAppAuthorized(Boolean isAppAuthorized)
Whether the file was created or opened by the requesting app.



File
setKind(String kind)
The type of file.



File
setLabels(File.Labels labels)
A group of labels for the file.



File
setLastModifyingUser(User lastModifyingUser)
The last user to modify this file.



File
setLastModifyingUserName(String lastModifyingUserName)
Name of the last user to modify this file.



File
setLastViewedByMeDate(com.google.api.client.util.DateTime lastViewedByMeDate)
Last time this file was viewed by the user (formatted RFC 3339 timestamp).



File
setMarkedViewedByMeDate(com.google.api.client.util.DateTime markedViewedByMeDate)
Deprecated.



File
setMd5Checksum(String md5Checksum)
An MD5 checksum for the content of this file.



File
setMimeType(String mimeType)
The MIME type of the file.



File
setModifiedByMeDate(com.google.api.client.util.DateTime modifiedByMeDate)
Last time this file was modified by the user (formatted RFC 3339 timestamp).



File
setModifiedDate(com.google.api.client.util.DateTime modifiedDate)
Last time this file was modified by anyone (formatted RFC 3339 timestamp).



File
setOpenWithLinks(Map<String,String> openWithLinks)
A map of the id of each of the user's apps to a link to open this file with that app.



File
setOriginalFilename(String originalFilename)
The original filename of the uploaded content if available, or else the original value of the
 title field.



File
setOwnedByMe(Boolean ownedByMe)
Whether the file is owned by the current user.



File
setOwnerNames(List<String> ownerNames)
Name(s) of the owner(s) of this file.



File
setOwners(List<User> owners)
The owner(s) of this file.



File
setParents(List<ParentReference> parents)
Collection of parent folders which contain this file.



File
setPermissionIds(List<String> permissionIds)
List of permission IDs for users with access to this file.



File
setPermissions(List<Permission> permissions)
The list of permissions for users with access to this file.



File
setProperties(List<Property> properties)
The list of properties.



File
setQuotaBytesUsed(Long quotaBytesUsed)
The number of quota bytes used by this file.



File
setSelfLink(String selfLink)
A link back to this file.



File
setShareable(Boolean shareable)
Deprecated: use capabilities/canShare.



File
setShared(Boolean shared)
Whether the file has been shared.



File
setSharedWithMeDate(com.google.api.client.util.DateTime sharedWithMeDate)
Time at which this file was shared with the user (formatted RFC 3339 timestamp).



File
setSharingUser(User sharingUser)
User that shared the item with the current user, if available.



File
setSpaces(List<String> spaces)
The list of spaces which contain the file.



File
setTeamDriveId(String teamDriveId)
ID of the Team Drive the file resides in.



File
setThumbnail(File.Thumbnail thumbnail)
A thumbnail for the file.



File
setThumbnailLink(String thumbnailLink)
A short-lived link to the file's thumbnail.



File
setThumbnailVersion(Long thumbnailVersion)
The thumbnail version for use in thumbnail cache invalidation.



File
setTitle(String title)
The title of this file.



File
setTrashedDate(com.google.api.client.util.DateTime trashedDate)
The time that the item was trashed (formatted RFC 3339 timestamp).



File
setTrashingUser(User trashingUser)
If the file has been explicitly trashed, the user who trashed it.



File
setUserPermission(Permission userPermission)
The permissions for the authenticated user on this file.



File
setVersion(Long version)
A monotonically increasing version number for the file.



File
setVideoMediaMetadata(File.VideoMediaMetadata videoMediaMetadata)
Metadata about video media.



File
setWebContentLink(String webContentLink)
A link for downloading the content of the file in a browser using cookie based authentication.



File
setWebViewLink(String webViewLink)
A link only available on public folders for viewing their static web assets (HTML, CSS, JS,
 etc) via Google Drive's Website Hosting.



File
setWritersCanShare(Boolean writersCanShare)
Whether writers can share the document with other users.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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





File
public File()









Method Detail





getAlternateLink
public String getAlternateLink()
A link for opening the file in a relevant Google editor or viewer.

Returns:
value or null for none








setAlternateLink
public File setAlternateLink(String alternateLink)
A link for opening the file in a relevant Google editor or viewer.

Parameters:
alternateLink - alternateLink or null for none








getAppDataContents
public Boolean getAppDataContents()
Whether this file is in the Application Data folder.

Returns:
value or null for none








setAppDataContents
public File setAppDataContents(Boolean appDataContents)
Whether this file is in the Application Data folder.

Parameters:
appDataContents - appDataContents or null for none








getCanComment
public Boolean getCanComment()
Deprecated: use capabilities/canComment.

Returns:
value or null for none








setCanComment
public File setCanComment(Boolean canComment)
Deprecated: use capabilities/canComment.

Parameters:
canComment - canComment or null for none








getCanReadRevisions
public Boolean getCanReadRevisions()
Deprecated: use capabilities/canReadRevisions.

Returns:
value or null for none








setCanReadRevisions
public File setCanReadRevisions(Boolean canReadRevisions)
Deprecated: use capabilities/canReadRevisions.

Parameters:
canReadRevisions - canReadRevisions or null for none








getCapabilities
public File.Capabilities getCapabilities()
Capabilities the current user has on this file. Each capability corresponds to a fine-grained
 action that a user may take.

Returns:
value or null for none








setCapabilities
public File setCapabilities(File.Capabilities capabilities)
Capabilities the current user has on this file. Each capability corresponds to a fine-grained
 action that a user may take.

Parameters:
capabilities - capabilities or null for none








getCopyRequiresWriterPermission
public Boolean getCopyRequiresWriterPermission()
Whether the options to copy, print, or download this file, should be disabled for readers and
 commenters.

Returns:
value or null for none








setCopyRequiresWriterPermission
public File setCopyRequiresWriterPermission(Boolean copyRequiresWriterPermission)
Whether the options to copy, print, or download this file, should be disabled for readers and
 commenters.

Parameters:
copyRequiresWriterPermission - copyRequiresWriterPermission or null for none








getCopyable
public Boolean getCopyable()
Deprecated: use capabilities/canCopy.

Returns:
value or null for none








setCopyable
public File setCopyable(Boolean copyable)
Deprecated: use capabilities/canCopy.

Parameters:
copyable - copyable or null for none








getCreatedDate
public com.google.api.client.util.DateTime getCreatedDate()
Create time for this file (formatted RFC 3339 timestamp).

Returns:
value or null for none








setCreatedDate
public File setCreatedDate(com.google.api.client.util.DateTime createdDate)
Create time for this file (formatted RFC 3339 timestamp).

Parameters:
createdDate - createdDate or null for none








getDefaultOpenWithLink
public String getDefaultOpenWithLink()
A link to open this file with the user's default app for this file. Only populated when the
 drive.apps.readonly scope is used.

Returns:
value or null for none








setDefaultOpenWithLink
public File setDefaultOpenWithLink(String defaultOpenWithLink)
A link to open this file with the user's default app for this file. Only populated when the
 drive.apps.readonly scope is used.

Parameters:
defaultOpenWithLink - defaultOpenWithLink or null for none








getDescription
public String getDescription()
A short description of the file.

Returns:
value or null for none








setDescription
public File setDescription(String description)
A short description of the file.

Parameters:
description - description or null for none








getDownloadUrl
public String getDownloadUrl()

Returns:
value or null for none








setDownloadUrl
public File setDownloadUrl(String downloadUrl)

Parameters:
downloadUrl - downloadUrl or null for none








getEditable
public Boolean getEditable()
Deprecated: use capabilities/canEdit.

Returns:
value or null for none








setEditable
public File setEditable(Boolean editable)
Deprecated: use capabilities/canEdit.

Parameters:
editable - editable or null for none








getEmbedLink
public String getEmbedLink()
A link for embedding the file.

Returns:
value or null for none








setEmbedLink
public File setEmbedLink(String embedLink)
A link for embedding the file.

Parameters:
embedLink - embedLink or null for none








getEtag
public String getEtag()
ETag of the file.

Returns:
value or null for none








setEtag
public File setEtag(String etag)
ETag of the file.

Parameters:
etag - etag or null for none








getExplicitlyTrashed
public Boolean getExplicitlyTrashed()
Whether this file has been explicitly trashed, as opposed to recursively trashed.

Returns:
value or null for none








setExplicitlyTrashed
public File setExplicitlyTrashed(Boolean explicitlyTrashed)
Whether this file has been explicitly trashed, as opposed to recursively trashed.

Parameters:
explicitlyTrashed - explicitlyTrashed or null for none








getExportLinks
public Map<String,String> getExportLinks()
Links for exporting Google Docs to specific formats.

Returns:
value or null for none








setExportLinks
public File setExportLinks(Map<String,String> exportLinks)
Links for exporting Google Docs to specific formats.

Parameters:
exportLinks - exportLinks or null for none








getFileExtension
public String getFileExtension()
The final component of fullFileExtension with trailing text that does not appear to be part of
 the extension removed. This field is only populated for files with content stored in Drive; it
 is not populated for Google Docs or shortcut files.

Returns:
value or null for none








setFileExtension
public File setFileExtension(String fileExtension)
The final component of fullFileExtension with trailing text that does not appear to be part of
 the extension removed. This field is only populated for files with content stored in Drive; it
 is not populated for Google Docs or shortcut files.

Parameters:
fileExtension - fileExtension or null for none








getFileSize
public Long getFileSize()
The size of the file in bytes. This field is only populated for files with content stored in
 Drive; it is not populated for Google Docs or shortcut files.

Returns:
value or null for none








setFileSize
public File setFileSize(Long fileSize)
The size of the file in bytes. This field is only populated for files with content stored in
 Drive; it is not populated for Google Docs or shortcut files.

Parameters:
fileSize - fileSize or null for none








getFolderColorRgb
public String getFolderColorRgb()
Folder color as an RGB hex string if the file is a folder. The list of supported colors is
 available in the folderColorPalette field of the About resource. If an unsupported color is
 specified, it will be changed to the closest color in the palette. Not populated for Team Drive
 files.

Returns:
value or null for none








setFolderColorRgb
public File setFolderColorRgb(String folderColorRgb)
Folder color as an RGB hex string if the file is a folder. The list of supported colors is
 available in the folderColorPalette field of the About resource. If an unsupported color is
 specified, it will be changed to the closest color in the palette. Not populated for Team Drive
 files.

Parameters:
folderColorRgb - folderColorRgb or null for none








getFullFileExtension
public String getFullFileExtension()
The full file extension; extracted from the title. May contain multiple concatenated
 extensions, such as "tar.gz". Removing an extension from the title does not clear this field;
 however, changing the extension on the title does update this field. This field is only
 populated for files with content stored in Drive; it is not populated for Google Docs or
 shortcut files.

Returns:
value or null for none








setFullFileExtension
public File setFullFileExtension(String fullFileExtension)
The full file extension; extracted from the title. May contain multiple concatenated
 extensions, such as "tar.gz". Removing an extension from the title does not clear this field;
 however, changing the extension on the title does update this field. This field is only
 populated for files with content stored in Drive; it is not populated for Google Docs or
 shortcut files.

Parameters:
fullFileExtension - fullFileExtension or null for none








getHasAugmentedPermissions
public Boolean getHasAugmentedPermissions()
Whether any users are granted file access directly on this file. This field is only populated
 for Team Drive files.

Returns:
value or null for none








setHasAugmentedPermissions
public File setHasAugmentedPermissions(Boolean hasAugmentedPermissions)
Whether any users are granted file access directly on this file. This field is only populated
 for Team Drive files.

Parameters:
hasAugmentedPermissions - hasAugmentedPermissions or null for none








getHasThumbnail
public Boolean getHasThumbnail()
Whether this file has a thumbnail. This does not indicate whether the requesting app has access
 to the thumbnail. To check access, look for the presence of the thumbnailLink field.

Returns:
value or null for none








setHasThumbnail
public File setHasThumbnail(Boolean hasThumbnail)
Whether this file has a thumbnail. This does not indicate whether the requesting app has access
 to the thumbnail. To check access, look for the presence of the thumbnailLink field.

Parameters:
hasThumbnail - hasThumbnail or null for none








getHeadRevisionId
public String getHeadRevisionId()
The ID of the file's head revision. This field is only populated for files with content stored
 in Drive; it is not populated for Google Docs or shortcut files.

Returns:
value or null for none








setHeadRevisionId
public File setHeadRevisionId(String headRevisionId)
The ID of the file's head revision. This field is only populated for files with content stored
 in Drive; it is not populated for Google Docs or shortcut files.

Parameters:
headRevisionId - headRevisionId or null for none








getIconLink
public String getIconLink()
A link to the file's icon.

Returns:
value or null for none








setIconLink
public File setIconLink(String iconLink)
A link to the file's icon.

Parameters:
iconLink - iconLink or null for none








getId
public String getId()
The ID of the file.

Returns:
value or null for none








setId
public File setId(String id)
The ID of the file.

Parameters:
id - id or null for none








getImageMediaMetadata
public File.ImageMediaMetadata getImageMediaMetadata()
Metadata about image media. This will only be present for image types, and its contents will
 depend on what can be parsed from the image content.

Returns:
value or null for none








setImageMediaMetadata
public File setImageMediaMetadata(File.ImageMediaMetadata imageMediaMetadata)
Metadata about image media. This will only be present for image types, and its contents will
 depend on what can be parsed from the image content.

Parameters:
imageMediaMetadata - imageMediaMetadata or null for none








getIndexableText
public File.IndexableText getIndexableText()
Indexable text attributes for the file (can only be written)

Returns:
value or null for none








setIndexableText
public File setIndexableText(File.IndexableText indexableText)
Indexable text attributes for the file (can only be written)

Parameters:
indexableText - indexableText or null for none








getIsAppAuthorized
public Boolean getIsAppAuthorized()
Whether the file was created or opened by the requesting app.

Returns:
value or null for none








setIsAppAuthorized
public File setIsAppAuthorized(Boolean isAppAuthorized)
Whether the file was created or opened by the requesting app.

Parameters:
isAppAuthorized - isAppAuthorized or null for none








getKind
public String getKind()
The type of file. This is always drive#file.

Returns:
value or null for none








setKind
public File setKind(String kind)
The type of file. This is always drive#file.

Parameters:
kind - kind or null for none








getLabels
public File.Labels getLabels()
A group of labels for the file.

Returns:
value or null for none








setLabels
public File setLabels(File.Labels labels)
A group of labels for the file.

Parameters:
labels - labels or null for none








getLastModifyingUser
public User getLastModifyingUser()
The last user to modify this file.

Returns:
value or null for none








setLastModifyingUser
public File setLastModifyingUser(User lastModifyingUser)
The last user to modify this file.

Parameters:
lastModifyingUser - lastModifyingUser or null for none








getLastModifyingUserName
public String getLastModifyingUserName()
Name of the last user to modify this file.

Returns:
value or null for none








setLastModifyingUserName
public File setLastModifyingUserName(String lastModifyingUserName)
Name of the last user to modify this file.

Parameters:
lastModifyingUserName - lastModifyingUserName or null for none








getLastViewedByMeDate
public com.google.api.client.util.DateTime getLastViewedByMeDate()
Last time this file was viewed by the user (formatted RFC 3339 timestamp).

Returns:
value or null for none








setLastViewedByMeDate
public File setLastViewedByMeDate(com.google.api.client.util.DateTime lastViewedByMeDate)
Last time this file was viewed by the user (formatted RFC 3339 timestamp).

Parameters:
lastViewedByMeDate - lastViewedByMeDate or null for none








getMarkedViewedByMeDate
public com.google.api.client.util.DateTime getMarkedViewedByMeDate()
Deprecated.

Returns:
value or null for none








setMarkedViewedByMeDate
public File setMarkedViewedByMeDate(com.google.api.client.util.DateTime markedViewedByMeDate)
Deprecated.

Parameters:
markedViewedByMeDate - markedViewedByMeDate or null for none








getMd5Checksum
public String getMd5Checksum()
An MD5 checksum for the content of this file. This field is only populated for files with
 content stored in Drive; it is not populated for Google Docs or shortcut files.

Returns:
value or null for none








setMd5Checksum
public File setMd5Checksum(String md5Checksum)
An MD5 checksum for the content of this file. This field is only populated for files with
 content stored in Drive; it is not populated for Google Docs or shortcut files.

Parameters:
md5Checksum - md5Checksum or null for none








getMimeType
public String getMimeType()
The MIME type of the file. This is only mutable on update when uploading new content. This
 field can be left blank, and the mimetype will be determined from the uploaded content's MIME
 type.

Returns:
value or null for none








setMimeType
public File setMimeType(String mimeType)
The MIME type of the file. This is only mutable on update when uploading new content. This
 field can be left blank, and the mimetype will be determined from the uploaded content's MIME
 type.

Parameters:
mimeType - mimeType or null for none








getModifiedByMeDate
public com.google.api.client.util.DateTime getModifiedByMeDate()
Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting
 modifiedDate will also update the modifiedByMe date for the user which set the date.

Returns:
value or null for none








setModifiedByMeDate
public File setModifiedByMeDate(com.google.api.client.util.DateTime modifiedByMeDate)
Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting
 modifiedDate will also update the modifiedByMe date for the user which set the date.

Parameters:
modifiedByMeDate - modifiedByMeDate or null for none








getModifiedDate
public com.google.api.client.util.DateTime getModifiedDate()
Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable
 on update when the setModifiedDate parameter is set.

Returns:
value or null for none








setModifiedDate
public File setModifiedDate(com.google.api.client.util.DateTime modifiedDate)
Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable
 on update when the setModifiedDate parameter is set.

Parameters:
modifiedDate - modifiedDate or null for none








getOpenWithLinks
public Map<String,String> getOpenWithLinks()
A map of the id of each of the user's apps to a link to open this file with that app. Only
 populated when the drive.apps.readonly scope is used.

Returns:
value or null for none








setOpenWithLinks
public File setOpenWithLinks(Map<String,String> openWithLinks)
A map of the id of each of the user's apps to a link to open this file with that app. Only
 populated when the drive.apps.readonly scope is used.

Parameters:
openWithLinks - openWithLinks or null for none








getOriginalFilename
public String getOriginalFilename()
The original filename of the uploaded content if available, or else the original value of the
 title field. This is only available for files with binary content in Drive.

Returns:
value or null for none








setOriginalFilename
public File setOriginalFilename(String originalFilename)
The original filename of the uploaded content if available, or else the original value of the
 title field. This is only available for files with binary content in Drive.

Parameters:
originalFilename - originalFilename or null for none








getOwnedByMe
public Boolean getOwnedByMe()
Whether the file is owned by the current user. Not populated for Team Drive files.

Returns:
value or null for none








setOwnedByMe
public File setOwnedByMe(Boolean ownedByMe)
Whether the file is owned by the current user. Not populated for Team Drive files.

Parameters:
ownedByMe - ownedByMe or null for none








getOwnerNames
public List<String> getOwnerNames()
Name(s) of the owner(s) of this file. Not populated for Team Drive files.

Returns:
value or null for none








setOwnerNames
public File setOwnerNames(List<String> ownerNames)
Name(s) of the owner(s) of this file. Not populated for Team Drive files.

Parameters:
ownerNames - ownerNames or null for none








getOwners
public List<User> getOwners()
The owner(s) of this file. Not populated for Team Drive files.

Returns:
value or null for none








setOwners
public File setOwners(List<User> owners)
The owner(s) of this file. Not populated for Team Drive files.

Parameters:
owners - owners or null for none








getParents
public List<ParentReference> getParents()
Collection of parent folders which contain this file. If not specified as part of an insert
 request, the file will be placed directly in the user's My Drive folder. If not specified as
 part of a copy request, the file will inherit any discoverable parents of the source file.
 Update requests can also use the addParents and removeParents parameters to modify the parents
 list.

Returns:
value or null for none








setParents
public File setParents(List<ParentReference> parents)
Collection of parent folders which contain this file. If not specified as part of an insert
 request, the file will be placed directly in the user's My Drive folder. If not specified as
 part of a copy request, the file will inherit any discoverable parents of the source file.
 Update requests can also use the addParents and removeParents parameters to modify the parents
 list.

Parameters:
parents - parents or null for none








getPermissionIds
public List<String> getPermissionIds()
List of permission IDs for users with access to this file.

Returns:
value or null for none








setPermissionIds
public File setPermissionIds(List<String> permissionIds)
List of permission IDs for users with access to this file.

Parameters:
permissionIds - permissionIds or null for none








getPermissions
public List<Permission> getPermissions()
The list of permissions for users with access to this file. Not populated for Team Drive files.

Returns:
value or null for none








setPermissions
public File setPermissions(List<Permission> permissions)
The list of permissions for users with access to this file. Not populated for Team Drive files.

Parameters:
permissions - permissions or null for none








getProperties
public List<Property> getProperties()
The list of properties.

Returns:
value or null for none








setProperties
public File setProperties(List<Property> properties)
The list of properties.

Parameters:
properties - properties or null for none








getQuotaBytesUsed
public Long getQuotaBytesUsed()
The number of quota bytes used by this file.

Returns:
value or null for none








setQuotaBytesUsed
public File setQuotaBytesUsed(Long quotaBytesUsed)
The number of quota bytes used by this file.

Parameters:
quotaBytesUsed - quotaBytesUsed or null for none








getSelfLink
public String getSelfLink()
A link back to this file.

Returns:
value or null for none








setSelfLink
public File setSelfLink(String selfLink)
A link back to this file.

Parameters:
selfLink - selfLink or null for none








getShareable
public Boolean getShareable()
Deprecated: use capabilities/canShare.

Returns:
value or null for none








setShareable
public File setShareable(Boolean shareable)
Deprecated: use capabilities/canShare.

Parameters:
shareable - shareable or null for none








getShared
public Boolean getShared()
Whether the file has been shared. Not populated for Team Drive files.

Returns:
value or null for none








setShared
public File setShared(Boolean shared)
Whether the file has been shared. Not populated for Team Drive files.

Parameters:
shared - shared or null for none








getSharedWithMeDate
public com.google.api.client.util.DateTime getSharedWithMeDate()
Time at which this file was shared with the user (formatted RFC 3339 timestamp).

Returns:
value or null for none








setSharedWithMeDate
public File setSharedWithMeDate(com.google.api.client.util.DateTime sharedWithMeDate)
Time at which this file was shared with the user (formatted RFC 3339 timestamp).

Parameters:
sharedWithMeDate - sharedWithMeDate or null for none








getSharingUser
public User getSharingUser()
User that shared the item with the current user, if available.

Returns:
value or null for none








setSharingUser
public File setSharingUser(User sharingUser)
User that shared the item with the current user, if available.

Parameters:
sharingUser - sharingUser or null for none








getSpaces
public List<String> getSpaces()
The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and
 'photos'.

Returns:
value or null for none








setSpaces
public File setSpaces(List<String> spaces)
The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and
 'photos'.

Parameters:
spaces - spaces or null for none








getTeamDriveId
public String getTeamDriveId()
ID of the Team Drive the file resides in.

Returns:
value or null for none








setTeamDriveId
public File setTeamDriveId(String teamDriveId)
ID of the Team Drive the file resides in.

Parameters:
teamDriveId - teamDriveId or null for none








getThumbnail
public File.Thumbnail getThumbnail()
A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.

Returns:
value or null for none








setThumbnail
public File setThumbnail(File.Thumbnail thumbnail)
A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.

Parameters:
thumbnail - thumbnail or null for none








getThumbnailLink
public String getThumbnailLink()
A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only
 populated when the requesting app can access the file's content.

Returns:
value or null for none








setThumbnailLink
public File setThumbnailLink(String thumbnailLink)
A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only
 populated when the requesting app can access the file's content.

Parameters:
thumbnailLink - thumbnailLink or null for none








getThumbnailVersion
public Long getThumbnailVersion()
The thumbnail version for use in thumbnail cache invalidation.

Returns:
value or null for none








setThumbnailVersion
public File setThumbnailVersion(Long thumbnailVersion)
The thumbnail version for use in thumbnail cache invalidation.

Parameters:
thumbnailVersion - thumbnailVersion or null for none








getTitle
public String getTitle()
The title of this file. Note that for immutable items such as the top level folders of Team
 Drives, My Drive root folder, and Application Data folder the title is constant.

Returns:
value or null for none








setTitle
public File setTitle(String title)
The title of this file. Note that for immutable items such as the top level folders of Team
 Drives, My Drive root folder, and Application Data folder the title is constant.

Parameters:
title - title or null for none








getTrashedDate
public com.google.api.client.util.DateTime getTrashedDate()
The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team
 Drive files.

Returns:
value or null for none








setTrashedDate
public File setTrashedDate(com.google.api.client.util.DateTime trashedDate)
The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team
 Drive files.

Parameters:
trashedDate - trashedDate or null for none








getTrashingUser
public User getTrashingUser()
If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive
 files.

Returns:
value or null for none








setTrashingUser
public File setTrashingUser(User trashingUser)
If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive
 files.

Parameters:
trashingUser - trashingUser or null for none








getUserPermission
public Permission getUserPermission()
The permissions for the authenticated user on this file.

Returns:
value or null for none








setUserPermission
public File setUserPermission(Permission userPermission)
The permissions for the authenticated user on this file.

Parameters:
userPermission - userPermission or null for none








getVersion
public Long getVersion()
A monotonically increasing version number for the file. This reflects every change made to the
 file on the server, even those not visible to the requesting user.

Returns:
value or null for none








setVersion
public File setVersion(Long version)
A monotonically increasing version number for the file. This reflects every change made to the
 file on the server, even those not visible to the requesting user.

Parameters:
version - version or null for none








getVideoMediaMetadata
public File.VideoMediaMetadata getVideoMediaMetadata()
Metadata about video media. This will only be present for video types.

Returns:
value or null for none








setVideoMediaMetadata
public File setVideoMediaMetadata(File.VideoMediaMetadata videoMediaMetadata)
Metadata about video media. This will only be present for video types.

Parameters:
videoMediaMetadata - videoMediaMetadata or null for none








getWebContentLink
public String getWebContentLink()
A link for downloading the content of the file in a browser using cookie based authentication.
 In cases where the content is shared publicly, the content can be downloaded without any
 credentials.

Returns:
value or null for none








setWebContentLink
public File setWebContentLink(String webContentLink)
A link for downloading the content of the file in a browser using cookie based authentication.
 In cases where the content is shared publicly, the content can be downloaded without any
 credentials.

Parameters:
webContentLink - webContentLink or null for none








getWebViewLink
public String getWebViewLink()
A link only available on public folders for viewing their static web assets (HTML, CSS, JS,
 etc) via Google Drive's Website Hosting.

Returns:
value or null for none








setWebViewLink
public File setWebViewLink(String webViewLink)
A link only available on public folders for viewing their static web assets (HTML, CSS, JS,
 etc) via Google Drive's Website Hosting.

Parameters:
webViewLink - webViewLink or null for none








getWritersCanShare
public Boolean getWritersCanShare()
Whether writers can share the document with other users. Not populated for Team Drive files.

Returns:
value or null for none








setWritersCanShare
public File setWritersCanShare(Boolean writersCanShare)
Whether writers can share the document with other users. Not populated for Team Drive files.

Parameters:
writersCanShare - writersCanShare or null for none








set
public File set(String fieldName,
                Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public File clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2018 Google. All rights reserved.