Drive.Files.List (Drive API v2 (Rev. 323) 1.23.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.drive.DriveRequest<FileList>
        
        com.google.api.services.drive.Drive.Files.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Drive.Files
```
public class Drive.Files.List
extends DriveRequest<FileList>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List()
Lists the user's files.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Lists the user's files.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getCorpora()` Comma-separated list of bodies of items (files/documents) to which the query applies.
`java.lang.String`	`getCorpus()` The body of items (files/documents) to which the query applies.
`java.lang.Boolean`	`getIncludeTeamDriveItems()` Whether Team Drive items should be included in results.
`java.lang.Integer`	`getMaxResults()` The maximum number of files to return per page.
`java.lang.String`	`getOrderBy()` A comma-separated list of sort keys.
`java.lang.String`	`getPageToken()` Page token for files.
`java.lang.String`	`getProjection()` This parameter is deprecated and has no function.
`java.lang.String`	`getQ()` Query string for searching files.
`java.lang.String`	`getSpaces()` A comma-separated list of spaces to query.
`java.lang.Boolean`	`getSupportsTeamDrives()` Whether the requesting application supports Team Drives.
`java.lang.String`	`getTeamDriveId()` ID of Team Drive to search.
`boolean`	`isIncludeTeamDriveItems()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`boolean`	`isSupportsTeamDrives()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`Drive.Files.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Drive.Files.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Drive.Files.List`	`setCorpora(java.lang.String corpora)` Comma-separated list of bodies of items (files/documents) to which the query applies.
`Drive.Files.List`	`setCorpus(java.lang.String corpus)` The body of items (files/documents) to which the query applies.
`Drive.Files.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Drive.Files.List`	`setIncludeTeamDriveItems(java.lang.Boolean includeTeamDriveItems)` Whether Team Drive items should be included in results.
`Drive.Files.List`	`setKey(java.lang.String key)` API key.
`Drive.Files.List`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of files to return per page.
`Drive.Files.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Drive.Files.List`	`setOrderBy(java.lang.String orderBy)` A comma-separated list of sort keys.
`Drive.Files.List`	`setPageToken(java.lang.String pageToken)` Page token for files.
`Drive.Files.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Drive.Files.List`	`setProjection(java.lang.String projection)` This parameter is deprecated and has no function.
`Drive.Files.List`	`setQ(java.lang.String q)` Query string for searching files.
`Drive.Files.List`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Drive.Files.List`	`setSpaces(java.lang.String spaces)` A comma-separated list of spaces to query.
`Drive.Files.List`	`setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)` Whether the requesting application supports Team Drives.
`Drive.Files.List`	`setTeamDriveId(java.lang.String teamDriveId)` ID of Team Drive to search.
`Drive.Files.List`	`setUserIp(java.lang.String userIp)` Deprecated.

Methods inherited from class com.google.api.services.drive.DriveRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List()
```
    Lists the user's files. Create a request for the method "files.list". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<FileList>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<FileList>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Drive.Files.List setAlt(java.lang.String alt)
```
    Description copied from class: DriveRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DriveRequest<FileList>
  - setFields
```
public Drive.Files.List setFields(java.lang.String fields)
```
    Description copied from class: DriveRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DriveRequest<FileList>
  - setKey
```
public Drive.Files.List setKey(java.lang.String key)
```
    Description copied from class: DriveRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class DriveRequest<FileList>
  - setOauthToken
```
public Drive.Files.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: DriveRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DriveRequest<FileList>
  - setPrettyPrint
```
public Drive.Files.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: DriveRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DriveRequest<FileList>
  - setQuotaUser
```
public Drive.Files.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: DriveRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class DriveRequest<FileList>
  - setUserIp
```
public Drive.Files.List setUserIp(java.lang.String userIp)
```
    Description copied from class: DriveRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class DriveRequest<FileList>
  - getCorpora
```
public java.lang.String getCorpora()
```
    Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'default'; all other values must be used in isolation. Prefer 'default' or 'teamDrive' to 'allTeamDrives' for efficiency.
  - setCorpora
```
public Drive.Files.List setCorpora(java.lang.String corpora)
```
    Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'default'; all other values must be used in isolation. Prefer 'default' or 'teamDrive' to 'allTeamDrives' for efficiency.
  - getCorpus
```
public java.lang.String getCorpus()
```
    The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.
  - setCorpus
```
public Drive.Files.List setCorpus(java.lang.String corpus)
```
    The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.
  - getIncludeTeamDriveItems
```
public java.lang.Boolean getIncludeTeamDriveItems()
```
    Whether Team Drive items should be included in results. [default: false]
  - setIncludeTeamDriveItems
```
public Drive.Files.List setIncludeTeamDriveItems(java.lang.Boolean includeTeamDriveItems)
```
    Whether Team Drive items should be included in results.
  - isIncludeTeamDriveItems
```
public boolean isIncludeTeamDriveItems()
```
    Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
    Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.
    
    This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.
    
    Whether Team Drive items should be included in results.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. [default: 100] [minimum: 0]
  - setMaxResults
```
public Drive.Files.List setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
  - setOrderBy
```
public Drive.Files.List setOrderBy(java.lang.String orderBy)
```
    A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
  - getPageToken
```
public java.lang.String getPageToken()
```
    Page token for files.
  - setPageToken
```
public Drive.Files.List setPageToken(java.lang.String pageToken)
```
    Page token for files.
  - getProjection
```
public java.lang.String getProjection()
```
    This parameter is deprecated and has no function.
  - setProjection
```
public Drive.Files.List setProjection(java.lang.String projection)
```
    This parameter is deprecated and has no function.
  - getQ
```
public java.lang.String getQ()
```
    Query string for searching files.
  - setQ
```
public Drive.Files.List setQ(java.lang.String q)
```
    Query string for searching files.
  - getSpaces
```
public java.lang.String getSpaces()
```
    A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
  - setSpaces
```
public Drive.Files.List setSpaces(java.lang.String spaces)
```
    A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
  - getSupportsTeamDrives
```
public java.lang.Boolean getSupportsTeamDrives()
```
    Whether the requesting application supports Team Drives. [default: false]
  - setSupportsTeamDrives
```
public Drive.Files.List setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)
```
    Whether the requesting application supports Team Drives.
  - isSupportsTeamDrives
```
public boolean isSupportsTeamDrives()
```
    Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
    Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.
    
    This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.
    
    Whether the requesting application supports Team Drives.
  - getTeamDriveId
```
public java.lang.String getTeamDriveId()
```
    ID of Team Drive to search.
  - setTeamDriveId
```
public Drive.Files.List setTeamDriveId(java.lang.String teamDriveId)
```
    ID of Team Drive to search.
  - set
```
public Drive.Files.List set(java.lang.String parameterName,
                            java.lang.Object value)
```
    Overrides:
    
    set in class DriveRequest<FileList>

Drive API v2 (revision 323)

Class Drive.Files.List

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.drive.DriveRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getCorpora

setCorpora

getCorpus

setCorpus

getIncludeTeamDriveItems

setIncludeTeamDriveItems

isIncludeTeamDriveItems

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getProjection

setProjection

getQ

setQ

getSpaces

setSpaces

getSupportsTeamDrives

setSupportsTeamDrives

isSupportsTeamDrives

getTeamDriveId

setTeamDriveId

set