File (Drive API v3 (Rev. 125) 1.18.0-rc)

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 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: http://code.google.com/p/google-http-java-client/wiki/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.ContentHints` Additional information about the content of the file.
`static class`	`File.ImageMediaMetadata` Additional metadata about image media, if available.
`static class`	`File.VideoMediaMetadata` Additional metadata about video media.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Constructor Summary

Constructors
Constructor and Description

File()

Constructors
Constructor and Description
`File()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`clone()`
`Map<String,String>`	`getAppProperties()` A collection of arbitrary key-value pairs which are private to the requesting app.
`File.Capabilities`	`getCapabilities()` Capabilities the current user has on this file.
`File.ContentHints`	`getContentHints()` Additional information about the content of the file.
`Boolean`	`getCopyRequiresWriterPermission()` Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
`DateTime`	`getCreatedTime()` The time at which the file was created (RFC 3339 date-time).
`String`	`getDescription()` A short description of the file.
`Boolean`	`getExplicitlyTrashed()` Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
`String`	`getFileExtension()` The final component of fullFileExtension.
`String`	`getFolderColorRgb()` The color for a folder as an RGB hex string.
`String`	`getFullFileExtension()` The full file extension extracted from the name field.
`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 static, unauthenticated link to the file's icon.
`String`	`getId()` The ID of the file.
`File.ImageMediaMetadata`	`getImageMediaMetadata()` Additional metadata about image media, if available.
`Boolean`	`getIsAppAuthorized()` Whether the file was created or opened by the requesting app.
`String`	`getKind()` Identifies what kind of resource this is.
`User`	`getLastModifyingUser()` The last user to modify the file.
`String`	`getMd5Checksum()` The MD5 checksum for the content of the file.
`String`	`getMimeType()` The MIME type of the file.
`Boolean`	`getModifiedByMe()` Whether the file has been modified by this user.
`DateTime`	`getModifiedByMeTime()` The last time the file was modified by the user (RFC 3339 date-time).
`DateTime`	`getModifiedTime()` The last time the file was modified by anyone (RFC 3339 date-time).
`String`	`getName()` The name of the file.
`String`	`getOriginalFilename()` The original filename of the uploaded content if available, or else the original value of the name field.
`Boolean`	`getOwnedByMe()` Whether the user owns the file.
`List<User>`	`getOwners()` The owners of the file.
`List<String>`	`getParents()` The IDs of the parent folders which contain the file.
`List<String>`	`getPermissionIds()` List of permission IDs for users with access to this file.
`List<Permission>`	`getPermissions()` The full list of permissions for the file.
`Map<String,String>`	`getProperties()` A collection of arbitrary key-value pairs which are visible to all apps.
`Long`	`getQuotaBytesUsed()` The number of storage quota bytes used by the file.
`Boolean`	`getShared()` Whether the file has been shared.
`DateTime`	`getSharedWithMeTime()` The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
`User`	`getSharingUser()` The user who shared the file with the requesting user, if applicable.
`Long`	`getSize()` The size of the file's content in bytes.
`List<String>`	`getSpaces()` The list of spaces which contain the file.
`Boolean`	`getStarred()` Whether the user has starred the file.
`String`	`getTeamDriveId()` ID of the Team Drive the file resides in.
`String`	`getThumbnailLink()` A short-lived link to the file's thumbnail, if available.
`Long`	`getThumbnailVersion()` The thumbnail version for use in thumbnail cache invalidation.
`Boolean`	`getTrashed()` Whether the file has been trashed, either explicitly or from a trashed parent folder.
`DateTime`	`getTrashedTime()` The time that the item was trashed (RFC 3339 date-time).
`User`	`getTrashingUser()` If the file has been explicitly trashed, the user who trashed it.
`Long`	`getVersion()` A monotonically increasing version number for the file.
`File.VideoMediaMetadata`	`getVideoMediaMetadata()` Additional metadata about video media.
`Boolean`	`getViewedByMe()` Whether the file has been viewed by this user.
`DateTime`	`getViewedByMeTime()` The last time the file was viewed by the user (RFC 3339 date-time).
`Boolean`	`getViewersCanCopyContent()` Deprecated - use copyRequiresWriterPermission instead.
`String`	`getWebContentLink()` A link for downloading the content of the file in a browser.
`String`	`getWebViewLink()` A link for opening the file in a relevant Google editor or viewer in a browser.
`Boolean`	`getWritersCanShare()` Whether users with only writer permission can modify the file's permissions.
`File`	`set(String fieldName, Object value)`
`File`	`setAppProperties(Map<String,String> appProperties)` A collection of arbitrary key-value pairs which are private to the requesting app.
`File`	`setCapabilities(File.Capabilities capabilities)` Capabilities the current user has on this file.
`File`	`setContentHints(File.ContentHints contentHints)` Additional information about the content of the file.
`File`	`setCopyRequiresWriterPermission(Boolean copyRequiresWriterPermission)` Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
`File`	`setCreatedTime(DateTime createdTime)` The time at which the file was created (RFC 3339 date-time).
`File`	`setDescription(String description)` A short description of the file.
`File`	`setExplicitlyTrashed(Boolean explicitlyTrashed)` Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
`File`	`setFileExtension(String fileExtension)` The final component of fullFileExtension.
`File`	`setFolderColorRgb(String folderColorRgb)` The color for a folder as an RGB hex string.
`File`	`setFullFileExtension(String fullFileExtension)` The full file extension extracted from the name field.
`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 static, unauthenticated link to the file's icon.
`File`	`setId(String id)` The ID of the file.
`File`	`setImageMediaMetadata(File.ImageMediaMetadata imageMediaMetadata)` Additional metadata about image media, if available.
`File`	`setIsAppAuthorized(Boolean isAppAuthorized)` Whether the file was created or opened by the requesting app.
`File`	`setKind(String kind)` Identifies what kind of resource this is.
`File`	`setLastModifyingUser(User lastModifyingUser)` The last user to modify the file.
`File`	`setMd5Checksum(String md5Checksum)` The MD5 checksum for the content of the file.
`File`	`setMimeType(String mimeType)` The MIME type of the file.
`File`	`setModifiedByMe(Boolean modifiedByMe)` Whether the file has been modified by this user.
`File`	`setModifiedByMeTime(DateTime modifiedByMeTime)` The last time the file was modified by the user (RFC 3339 date-time).
`File`	`setModifiedTime(DateTime modifiedTime)` The last time the file was modified by anyone (RFC 3339 date-time).
`File`	`setName(String name)` The name of the file.
`File`	`setOriginalFilename(String originalFilename)` The original filename of the uploaded content if available, or else the original value of the name field.
`File`	`setOwnedByMe(Boolean ownedByMe)` Whether the user owns the file.
`File`	`setOwners(List<User> owners)` The owners of the file.
`File`	`setParents(List<String> parents)` The IDs of the parent folders which contain the file.
`File`	`setPermissionIds(List<String> permissionIds)` List of permission IDs for users with access to this file.
`File`	`setPermissions(List<Permission> permissions)` The full list of permissions for the file.
`File`	`setProperties(Map<String,String> properties)` A collection of arbitrary key-value pairs which are visible to all apps.
`File`	`setQuotaBytesUsed(Long quotaBytesUsed)` The number of storage quota bytes used by the file.
`File`	`setShared(Boolean shared)` Whether the file has been shared.
`File`	`setSharedWithMeTime(DateTime sharedWithMeTime)` The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
`File`	`setSharingUser(User sharingUser)` The user who shared the file with the requesting user, if applicable.
`File`	`setSize(Long size)` The size of the file's content in bytes.
`File`	`setSpaces(List<String> spaces)` The list of spaces which contain the file.
`File`	`setStarred(Boolean starred)` Whether the user has starred the file.
`File`	`setTeamDriveId(String teamDriveId)` ID of the Team Drive the file resides in.
`File`	`setThumbnailLink(String thumbnailLink)` A short-lived link to the file's thumbnail, if available.
`File`	`setThumbnailVersion(Long thumbnailVersion)` The thumbnail version for use in thumbnail cache invalidation.
`File`	`setTrashed(Boolean trashed)` Whether the file has been trashed, either explicitly or from a trashed parent folder.
`File`	`setTrashedTime(DateTime trashedTime)` The time that the item was trashed (RFC 3339 date-time).
`File`	`setTrashingUser(User trashingUser)` If the file has been explicitly trashed, the user who trashed it.
`File`	`setVersion(Long version)` A monotonically increasing version number for the file.
`File`	`setVideoMediaMetadata(File.VideoMediaMetadata videoMediaMetadata)` Additional metadata about video media.
`File`	`setViewedByMe(Boolean viewedByMe)` Whether the file has been viewed by this user.
`File`	`setViewedByMeTime(DateTime viewedByMeTime)` The last time the file was viewed by the user (RFC 3339 date-time).
`File`	`setViewersCanCopyContent(Boolean viewersCanCopyContent)` Deprecated - use copyRequiresWriterPermission instead.
`File`	`setWebContentLink(String webContentLink)` A link for downloading the content of the file in a browser.
`File`	`setWebViewLink(String webViewLink)` A link for opening the file in a relevant Google editor or viewer in a browser.
`File`	`setWritersCanShare(Boolean writersCanShare)` Whether users with only writer permission can modify the file's permissions.

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
  - getAppProperties
```
public Map<String,String> getAppProperties()
```
    A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests.
    
    Returns:
    
    value or null for none
  - setAppProperties
```
public File setAppProperties(Map<String,String> appProperties)
```
    A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests.
    
    Parameters:
    
    appProperties - appProperties 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
  - getContentHints
```
public File.ContentHints getContentHints()
```
    Additional information about the content of the file. These fields are never populated in responses.
    
    Returns:
    
    value or null for none
  - setContentHints
```
public File setContentHints(File.ContentHints contentHints)
```
    Additional information about the content of the file. These fields are never populated in responses.
    
    Parameters:
    
    contentHints - contentHints 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
  - getCreatedTime
```
public DateTime getCreatedTime()
```
    The time at which the file was created (RFC 3339 date-time).
    
    Returns:
    
    value or null for none
  - setCreatedTime
```
public File setCreatedTime(DateTime createdTime)
```
    The time at which the file was created (RFC 3339 date-time).
    
    Parameters:
    
    createdTime - createdTime 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
  - getExplicitlyTrashed
```
public Boolean getExplicitlyTrashed()
```
    Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
    
    Returns:
    
    value or null for none
  - setExplicitlyTrashed
```
public File setExplicitlyTrashed(Boolean explicitlyTrashed)
```
    Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
    
    Parameters:
    
    explicitlyTrashed - explicitlyTrashed or null for none
  - getFileExtension
```
public String getFileExtension()
```
    The final component of fullFileExtension. This is only available for files with binary content in Drive.
    
    Returns:
    
    value or null for none
  - setFileExtension
```
public File setFileExtension(String fileExtension)
```
    The final component of fullFileExtension. This is only available for files with binary content in Drive.
    
    Parameters:
    
    fileExtension - fileExtension or null for none
  - getFolderColorRgb
```
public String getFolderColorRgb()
```
    The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.
    
    Returns:
    
    value or null for none
  - setFolderColorRgb
```
public File setFolderColorRgb(String folderColorRgb)
```
    The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.
    
    Parameters:
    
    folderColorRgb - folderColorRgb or null for none
  - getFullFileExtension
```
public String getFullFileExtension()
```
    The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
    
    Returns:
    
    value or null for none
  - setFullFileExtension
```
public File setFullFileExtension(String fullFileExtension)
```
    The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
    
    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 is currently only available for files with binary content in Drive.
    
    Returns:
    
    value or null for none
  - setHeadRevisionId
```
public File setHeadRevisionId(String headRevisionId)
```
    The ID of the file's head revision. This is currently only available for files with binary content in Drive.
    
    Parameters:
    
    headRevisionId - headRevisionId or null for none
  - getIconLink
```
public String getIconLink()
```
    A static, unauthenticated link to the file's icon.
    
    Returns:
    
    value or null for none
  - setIconLink
```
public File setIconLink(String iconLink)
```
    A static, unauthenticated 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()
```
    Additional metadata about image media, if available.
    
    Returns:
    
    value or null for none
  - setImageMediaMetadata
```
public File setImageMediaMetadata(File.ImageMediaMetadata imageMediaMetadata)
```
    Additional metadata about image media, if available.
    
    Parameters:
    
    imageMediaMetadata - imageMediaMetadata 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()
```
    Identifies what kind of resource this is. Value: the fixed string "drive#file".
    
    Returns:
    
    value or null for none
  - setKind
```
public File setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "drive#file".
    
    Parameters:
    
    kind - kind or null for none
  - getLastModifyingUser
```
public User getLastModifyingUser()
```
    The last user to modify the file.
    
    Returns:
    
    value or null for none
  - setLastModifyingUser
```
public File setLastModifyingUser(User lastModifyingUser)
```
    The last user to modify the file.
    
    Parameters:
    
    lastModifyingUser - lastModifyingUser or null for none
  - getMd5Checksum
```
public String getMd5Checksum()
```
    The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
    
    Returns:
    
    value or null for none
  - setMd5Checksum
```
public File setMd5Checksum(String md5Checksum)
```
    The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
    
    Parameters:
    
    md5Checksum - md5Checksum or null for none
  - getMimeType
```
public String getMimeType()
```
    The MIME type of the file. Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
    
    Returns:
    
    value or null for none
  - setMimeType
```
public File setMimeType(String mimeType)
```
    The MIME type of the file. Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
    
    Parameters:
    
    mimeType - mimeType or null for none
  - getModifiedByMe
```
public Boolean getModifiedByMe()
```
    Whether the file has been modified by this user.
    
    Returns:
    
    value or null for none
  - setModifiedByMe
```
public File setModifiedByMe(Boolean modifiedByMe)
```
    Whether the file has been modified by this user.
    
    Parameters:
    
    modifiedByMe - modifiedByMe or null for none
  - getModifiedByMeTime
```
public DateTime getModifiedByMeTime()
```
    The last time the file was modified by the user (RFC 3339 date-time).
    
    Returns:
    
    value or null for none
  - setModifiedByMeTime
```
public File setModifiedByMeTime(DateTime modifiedByMeTime)
```
    The last time the file was modified by the user (RFC 3339 date-time).
    
    Parameters:
    
    modifiedByMeTime - modifiedByMeTime or null for none
  - getModifiedTime
```
public DateTime getModifiedTime()
```
    The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
    
    Returns:
    
    value or null for none
  - setModifiedTime
```
public File setModifiedTime(DateTime modifiedTime)
```
    The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
    
    Parameters:
    
    modifiedTime - modifiedTime or null for none
  - getName
```
public String getName()
```
    The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
    
    Returns:
    
    value or null for none
  - setName
```
public File setName(String name)
```
    The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
    
    Parameters:
    
    name - name or null for none
  - getOriginalFilename
```
public String getOriginalFilename()
```
    The original filename of the uploaded content if available, or else the original value of the name 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 name 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 user owns the file. Not populated for Team Drive files.
    
    Returns:
    
    value or null for none
  - setOwnedByMe
```
public File setOwnedByMe(Boolean ownedByMe)
```
    Whether the user owns the file. Not populated for Team Drive files.
    
    Parameters:
    
    ownedByMe - ownedByMe or null for none
  - getOwners
```
public List<User> getOwners()
```
    The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for Team Drive files.
    
    Returns:
    
    value or null for none
  - setOwners
```
public File setOwners(List<User> owners)
```
    The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for Team Drive files.
    
    Parameters:
    
    owners - owners or null for none
  - getParents
```
public List<String> getParents()
```
    The IDs of the parent folders which contain the file. If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.
    
    Returns:
    
    value or null for none
  - setParents
```
public File setParents(List<String> parents)
```
    The IDs of the parent folders which contain the file. If not specified as part of a create 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 must 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 full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for Team Drive files.
    
    Returns:
    
    value or null for none
  - setPermissions
```
public File setPermissions(List<Permission> permissions)
```
    The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for Team Drive files.
    
    Parameters:
    
    permissions - permissions or null for none
  - getProperties
```
public Map<String,String> getProperties()
```
    A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.
    
    Returns:
    
    value or null for none
  - setProperties
```
public File setProperties(Map<String,String> properties)
```
    A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.
    
    Parameters:
    
    properties - properties or null for none
  - getQuotaBytesUsed
```
public Long getQuotaBytesUsed()
```
    The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
    
    Returns:
    
    value or null for none
  - setQuotaBytesUsed
```
public File setQuotaBytesUsed(Long quotaBytesUsed)
```
    The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
    
    Parameters:
    
    quotaBytesUsed - quotaBytesUsed 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
  - getSharedWithMeTime
```
public DateTime getSharedWithMeTime()
```
    The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
    
    Returns:
    
    value or null for none
  - setSharedWithMeTime
```
public File setSharedWithMeTime(DateTime sharedWithMeTime)
```
    The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
    
    Parameters:
    
    sharedWithMeTime - sharedWithMeTime or null for none
  - getSharingUser
```
public User getSharingUser()
```
    The user who shared the file with the requesting user, if applicable.
    
    Returns:
    
    value or null for none
  - setSharingUser
```
public File setSharingUser(User sharingUser)
```
    The user who shared the file with the requesting user, if applicable.
    
    Parameters:
    
    sharingUser - sharingUser or null for none
  - getSize
```
public Long getSize()
```
    The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
    
    Returns:
    
    value or null for none
  - setSize
```
public File setSize(Long size)
```
    The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
    
    Parameters:
    
    size - size or null for none
  - getSpaces
```
public List<String> getSpaces()
```
    The list of spaces which contain the file. The currently 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. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
    
    Parameters:
    
    spaces - spaces or null for none
  - getStarred
```
public Boolean getStarred()
```
    Whether the user has starred the file.
    
    Returns:
    
    value or null for none
  - setStarred
```
public File setStarred(Boolean starred)
```
    Whether the user has starred the file.
    
    Parameters:
    
    starred - starred 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
  - getThumbnailLink
```
public String getThumbnailLink()
```
    A short-lived link to the file's thumbnail, if available. 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, if available. 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
  - getTrashed
```
public Boolean getTrashed()
```
    Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
    
    Returns:
    
    value or null for none
  - setTrashed
```
public File setTrashed(Boolean trashed)
```
    Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
    
    Parameters:
    
    trashed - trashed or null for none
  - getTrashedTime
```
public DateTime getTrashedTime()
```
    The time that the item was trashed (RFC 3339 date-time). Only populated for Team Drive files.
    
    Returns:
    
    value or null for none
  - setTrashedTime
```
public File setTrashedTime(DateTime trashedTime)
```
    The time that the item was trashed (RFC 3339 date-time). Only populated for Team Drive files.
    
    Parameters:
    
    trashedTime - trashedTime 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
  - 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 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 user.
    
    Parameters:
    
    version - version or null for none
  - getVideoMediaMetadata
```
public File.VideoMediaMetadata getVideoMediaMetadata()
```
    Additional metadata about video media. This may not be available immediately upon upload.
    
    Returns:
    
    value or null for none
  - setVideoMediaMetadata
```
public File setVideoMediaMetadata(File.VideoMediaMetadata videoMediaMetadata)
```
    Additional metadata about video media. This may not be available immediately upon upload.
    
    Parameters:
    
    videoMediaMetadata - videoMediaMetadata or null for none
  - getViewedByMe
```
public Boolean getViewedByMe()
```
    Whether the file has been viewed by this user.
    
    Returns:
    
    value or null for none
  - setViewedByMe
```
public File setViewedByMe(Boolean viewedByMe)
```
    Whether the file has been viewed by this user.
    
    Parameters:
    
    viewedByMe - viewedByMe or null for none
  - getViewedByMeTime
```
public DateTime getViewedByMeTime()
```
    The last time the file was viewed by the user (RFC 3339 date-time).
    
    Returns:
    
    value or null for none
  - setViewedByMeTime
```
public File setViewedByMeTime(DateTime viewedByMeTime)
```
    The last time the file was viewed by the user (RFC 3339 date-time).
    
    Parameters:
    
    viewedByMeTime - viewedByMeTime or null for none
  - getViewersCanCopyContent
```
public Boolean getViewersCanCopyContent()
```
    Deprecated - use copyRequiresWriterPermission instead.
    
    Returns:
    
    value or null for none
  - setViewersCanCopyContent
```
public File setViewersCanCopyContent(Boolean viewersCanCopyContent)
```
    Deprecated - use copyRequiresWriterPermission instead.
    
    Parameters:
    
    viewersCanCopyContent - viewersCanCopyContent or null for none
  - getWebContentLink
```
public String getWebContentLink()
```
    A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
    
    Returns:
    
    value or null for none
  - setWebContentLink
```
public File setWebContentLink(String webContentLink)
```
    A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
    
    Parameters:
    
    webContentLink - webContentLink or null for none
  - getWebViewLink
```
public String getWebViewLink()
```
    A link for opening the file in a relevant Google editor or viewer in a browser.
    
    Returns:
    
    value or null for none
  - setWebViewLink
```
public File setWebViewLink(String webViewLink)
```
    A link for opening the file in a relevant Google editor or viewer in a browser.
    
    Parameters:
    
    webViewLink - webViewLink or null for none
  - getWritersCanShare
```
public Boolean getWritersCanShare()
```
    Whether users with only writer permission can modify the file's permissions. Not populated for Team Drive files.
    
    Returns:
    
    value or null for none
  - setWritersCanShare
```
public File setWritersCanShare(Boolean writersCanShare)
```
    Whether users with only writer permission can modify the file's permissions. 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 GenericJson
  - clone
```
public File clone()
```
    Overrides:
    
    clone in class GenericJson

Drive API v3 (revision 125)

Class File

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

File

Method Detail

getAppProperties

setAppProperties

getCapabilities

setCapabilities

getContentHints

setContentHints

getCopyRequiresWriterPermission

setCopyRequiresWriterPermission

getCreatedTime

setCreatedTime

getDescription

setDescription

getExplicitlyTrashed

setExplicitlyTrashed

getFileExtension

setFileExtension

getFolderColorRgb

setFolderColorRgb

getFullFileExtension

setFullFileExtension

getHasAugmentedPermissions

setHasAugmentedPermissions

getHasThumbnail

setHasThumbnail

getHeadRevisionId

setHeadRevisionId

getIconLink

setIconLink

getId

setId

getImageMediaMetadata

setImageMediaMetadata

getIsAppAuthorized

setIsAppAuthorized

getKind

setKind

getLastModifyingUser

setLastModifyingUser

getMd5Checksum

setMd5Checksum

getMimeType

setMimeType

getModifiedByMe

setModifiedByMe

getModifiedByMeTime

setModifiedByMeTime

getModifiedTime

setModifiedTime

getName

setName

getOriginalFilename

setOriginalFilename

getOwnedByMe

setOwnedByMe

getOwners

setOwners

getParents

setParents

getPermissionIds

setPermissionIds

getPermissions

setPermissions

getProperties

setProperties