File (Drive API v1 (Rev. 86) 1.16.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.IndexableText` Indexable text attributes for the file (can only be written)
`static class`	`File.Labels` Labels for the file.
`static class`	`File.ParentsCollection` Model definition for FileParentsCollection.

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

Methods
Modifier and Type	Method and Description
`File`	`clone()`
`DateTime`	`getCreatedDate()` Create time for this file (formatted ISO8601 timestamp).
`String`	`getDescription()` A short description of the file
`String`	`getDownloadUrl()` Short term download URL for the file.
`String`	`getEtag()` ETag of the file.
`String`	`getFileExtension()` The file extension used when downloading this file.
`Long`	`getFileSize()` The size of the file in bytes.
`String`	`getId()` The id of the file.
`File.IndexableText`	`getIndexableText()` Indexable text attributes for the file (can only be written)
`String`	`getKind()` The type of file.
`File.Labels`	`getLabels()` Labels for the file.
`DateTime`	`getLastViewedDate()` Last time this file was viewed by the user (formatted RFC 3339 timestamp).
`String`	`getMd5Checksum()` An MD5 checksum for the content of this file.
`String`	`getMimeType()` The mimetype of the file
`DateTime`	`getModifiedByMeDate()` Last time this file was modified by the user (formatted RFC 3339 timestamp).
`DateTime`	`getModifiedDate()` Last time this file was modified by anyone (formatted RFC 3339 timestamp).
`List<File.ParentsCollection>`	`getParentsCollection()` Collection of parent folders which contain this file.
`String`	`getSelfLink()` A link back to this file.
`String`	`getTitle()` The title of this file.
`Permission`	`getUserPermission()` The permissions for the authenticated user on this file.
`File`	`set(String fieldName, Object value)`
`File`	`setCreatedDate(DateTime createdDate)` Create time for this file (formatted ISO8601 timestamp).
`File`	`setDescription(String description)` A short description of the file
`File`	`setDownloadUrl(String downloadUrl)` Short term download URL for the file.
`File`	`setEtag(String etag)` ETag of the file.
`File`	`setFileExtension(String fileExtension)` The file extension used when downloading this file.
`File`	`setFileSize(Long fileSize)` The size of the file in bytes.
`File`	`setId(String id)` The id of the file.
`File`	`setIndexableText(File.IndexableText indexableText)` Indexable text attributes for the file (can only be written)
`File`	`setKind(String kind)` The type of file.
`File`	`setLabels(File.Labels labels)` Labels for the file.
`File`	`setLastViewedDate(DateTime lastViewedDate)` Last time this file was viewed by the user (formatted RFC 3339 timestamp).
`File`	`setMd5Checksum(String md5Checksum)` An MD5 checksum for the content of this file.
`File`	`setMimeType(String mimeType)` The mimetype of the file
`File`	`setModifiedByMeDate(DateTime modifiedByMeDate)` Last time this file was modified by the user (formatted RFC 3339 timestamp).
`File`	`setModifiedDate(DateTime modifiedDate)` Last time this file was modified by anyone (formatted RFC 3339 timestamp).
`File`	`setParentsCollection(List<File.ParentsCollection> parentsCollection)` Collection of parent folders which contain this file.
`File`	`setSelfLink(String selfLink)` A link back to this file.
`File`	`setTitle(String title)` The title of this file.
`File`	`setUserPermission(Permission userPermission)` The permissions for the authenticated user on this file.

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

- Constructor Detail
  - File
```
public File()
```
- Method Detail
  - getCreatedDate
```
public DateTime getCreatedDate()
```
    Create time for this file (formatted ISO8601 timestamp).
    
    Returns:
    value or null for none
  - setCreatedDate
```
public File setCreatedDate(DateTime createdDate)
```
    Create time for this file (formatted ISO8601 timestamp).
    
    Parameters:
    createdDate - createdDate 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()
```
    Short term download URL for the file. This will only be populated on files with content stored in Drive.
    
    Returns:
    value or null for none
  - setDownloadUrl
```
public File setDownloadUrl(String downloadUrl)
```
    Short term download URL for the file. This will only be populated on files with content stored in Drive.
    
    Parameters:
    downloadUrl - downloadUrl 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
  - getFileExtension
```
public String getFileExtension()
```
    The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
    
    Returns:
    value or null for none
  - setFileExtension
```
public File setFileExtension(String fileExtension)
```
    The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
    
    Parameters:
    fileExtension - fileExtension or null for none
  - getFileSize
```
public Long getFileSize()
```
    The size of the file in bytes. This will only be populated on files with content stored in Drive.
    
    Returns:
    value or null for none
  - setFileSize
```
public File setFileSize(Long fileSize)
```
    The size of the file in bytes. This will only be populated on files with content stored in Drive.
    
    Parameters:
    fileSize - fileSize 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
  - 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
  - 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()
```
    Labels for the file.
    
    Returns:
    value or null for none
  - setLabels
```
public File setLabels(File.Labels labels)
```
    Labels for the file.
    
    Parameters:
    labels - labels or null for none
  - getLastViewedDate
```
public DateTime getLastViewedDate()
```
    Last time this file was viewed by the user (formatted RFC 3339 timestamp).
    
    Returns:
    value or null for none
  - setLastViewedDate
```
public File setLastViewedDate(DateTime lastViewedDate)
```
    Last time this file was viewed by the user (formatted RFC 3339 timestamp).
    
    Parameters:
    lastViewedDate - lastViewedDate or null for none
  - getMd5Checksum
```
public String getMd5Checksum()
```
    An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
    
    Returns:
    value or null for none
  - setMd5Checksum
```
public File setMd5Checksum(String md5Checksum)
```
    An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
    
    Parameters:
    md5Checksum - md5Checksum or null for none
  - getMimeType
```
public String getMimeType()
```
    The mimetype of the file
    
    Returns:
    value or null for none
  - setMimeType
```
public File setMimeType(String mimeType)
```
    The mimetype of the file
    
    Parameters:
    mimeType - mimeType or null for none
  - getModifiedByMeDate
```
public DateTime getModifiedByMeDate()
```
    Last time this file was modified by the user (formatted RFC 3339 timestamp).
    
    Returns:
    value or null for none
  - setModifiedByMeDate
```
public File setModifiedByMeDate(DateTime modifiedByMeDate)
```
    Last time this file was modified by the user (formatted RFC 3339 timestamp).
    
    Parameters:
    modifiedByMeDate - modifiedByMeDate or null for none
  - getModifiedDate
```
public DateTime getModifiedDate()
```
    Last time this file was modified by anyone (formatted RFC 3339 timestamp).
    
    Returns:
    value or null for none
  - setModifiedDate
```
public File setModifiedDate(DateTime modifiedDate)
```
    Last time this file was modified by anyone (formatted RFC 3339 timestamp).
    
    Parameters:
    modifiedDate - modifiedDate or null for none
  - getParentsCollection
```
public List<File.ParentsCollection> getParentsCollection()
```
    Collection of parent folders which contain this file. On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
    
    Returns:
    value or null for none
  - setParentsCollection
```
public File setParentsCollection(List<File.ParentsCollection> parentsCollection)
```
    Collection of parent folders which contain this file. On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
    
    Parameters:
    parentsCollection - parentsCollection 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
  - getTitle
```
public String getTitle()
```
    The title of this file.
    
    Returns:
    value or null for none
  - setTitle
```
public File setTitle(String title)
```
    The title of this file.
    
    Parameters:
    title - title 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
  - set
```
public File set(String fieldName,
       Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public File clone()
```
    Overrides:
    
    clone in class GenericJson

Drive API v1 (revision 86)

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

Constructor Detail

File

Method Detail

getCreatedDate

setCreatedDate

getDescription

setDescription

getDownloadUrl

setDownloadUrl

getEtag

setEtag

getFileExtension

setFileExtension

getFileSize

setFileSize

getId

setId

getIndexableText

setIndexableText

getKind

setKind

getLabels

setLabels

getLastViewedDate

setLastViewedDate

getMd5Checksum

setMd5Checksum

getMimeType

setMimeType

getModifiedByMeDate

setModifiedByMeDate

getModifiedDate

setModifiedDate

getParentsCollection

setParentsCollection

getSelfLink

setSelfLink

getTitle

setTitle

getUserPermission

setUserPermission

set

clone