Drive.Files.List (Drive API v3 (Rev. 197) 1.25.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 or searches files.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Lists or searches 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()` Bodies of items (files/documents) to which the query applies.
`java.lang.String`	`getCorpus()` The source of files to list.
`java.lang.String`	`getDriveId()` ID of the shared drive to search.
`java.lang.Boolean`	`getIncludeItemsFromAllDrives()` Deprecated - Whether both My Drive and shared drive items should be included in results.
`java.lang.Boolean`	`getIncludeTeamDriveItems()` Deprecated use includeItemsFromAllDrives instead.
`java.lang.String`	`getOrderBy()` A comma-separated list of sort keys.
`java.lang.Integer`	`getPageSize()` The maximum number of files to return per page.
`java.lang.String`	`getPageToken()` The token for continuing a previous list request on the next page.
`java.lang.String`	`getQ()` A query for filtering the file results.
`java.lang.String`	`getSpaces()` A comma-separated list of spaces to query within the corpus.
`java.lang.Boolean`	`getSupportsAllDrives()` Deprecated - Whether the requesting application supports both My Drives and shared drives.
`java.lang.Boolean`	`getSupportsTeamDrives()` Deprecated use supportsAllDrives instead.
`java.lang.String`	`getTeamDriveId()` Deprecated use driveId instead.
`boolean`	`isIncludeItemsFromAllDrives()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`boolean`	`isIncludeTeamDriveItems()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`boolean`	`isSupportsAllDrives()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`boolean`	`isSupportsTeamDrives()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`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)` Bodies of items (files/documents) to which the query applies.
`Drive.Files.List`	`setCorpus(java.lang.String corpus)` The source of files to list.
`Drive.Files.List`	`setDriveId(java.lang.String driveId)` ID of the shared drive to search.
`Drive.Files.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Drive.Files.List`	`setIncludeItemsFromAllDrives(java.lang.Boolean includeItemsFromAllDrives)` Deprecated - Whether both My Drive and shared drive items should be included in results.
`Drive.Files.List`	`setIncludeTeamDriveItems(java.lang.Boolean includeTeamDriveItems)` Deprecated use includeItemsFromAllDrives instead.
`Drive.Files.List`	`setKey(java.lang.String key)` API key.
`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`	`setPageSize(java.lang.Integer pageSize)` The maximum number of files to return per page.
`Drive.Files.List`	`setPageToken(java.lang.String pageToken)` The token for continuing a previous list request on the next page.
`Drive.Files.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Drive.Files.List`	`setQ(java.lang.String q)` A query for filtering the file results.
`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 within the corpus.
`Drive.Files.List`	`setSupportsAllDrives(java.lang.Boolean supportsAllDrives)` Deprecated - Whether the requesting application supports both My Drives and shared drives.
`Drive.Files.List`	`setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)` Deprecated use supportsAllDrives instead.
`Drive.Files.List`	`setTeamDriveId(java.lang.String teamDriveId)` Deprecated use driveId instead.
`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 or searches 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()
```
    Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.
  - setCorpora
```
public Drive.Files.List setCorpora(java.lang.String corpora)
```
    Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.
  - getCorpus
```
public java.lang.String getCorpus()
```
    The source of files to list. Deprecated: use 'corpora' instead.
  - setCorpus
```
public Drive.Files.List setCorpus(java.lang.String corpus)
```
    The source of files to list. Deprecated: use 'corpora' instead.
  - getDriveId
```
public java.lang.String getDriveId()
```
    ID of the shared drive to search.
  - setDriveId
```
public Drive.Files.List setDriveId(java.lang.String driveId)
```
    ID of the shared drive to search.
  - getIncludeItemsFromAllDrives
```
public java.lang.Boolean getIncludeItemsFromAllDrives()
```
    Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. [default: false]
  - setIncludeItemsFromAllDrives
```
public Drive.Files.List setIncludeItemsFromAllDrives(java.lang.Boolean includeItemsFromAllDrives)
```
    Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
  - isIncludeItemsFromAllDrives
```
public boolean isIncludeItemsFromAllDrives()
```
    Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
    Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.
    
    This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.
    
    Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
  - getIncludeTeamDriveItems
```
public java.lang.Boolean getIncludeTeamDriveItems()
```
    Deprecated use includeItemsFromAllDrives instead. [default: false]
  - setIncludeTeamDriveItems
```
public Drive.Files.List setIncludeTeamDriveItems(java.lang.Boolean includeTeamDriveItems)
```
    Deprecated use includeItemsFromAllDrives instead.
  - 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.
    
    Deprecated use includeItemsFromAllDrives instead.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. 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 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
  - getPageSize
```
public java.lang.Integer getPageSize()
```
    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: 1] [maximum: 1000]
  - setPageSize
```
public Drive.Files.List setPageSize(java.lang.Integer pageSize)
```
    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.
  - getPageToken
```
public java.lang.String getPageToken()
```
    The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  - setPageToken
```
public Drive.Files.List setPageToken(java.lang.String pageToken)
```
    The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  - getQ
```
public java.lang.String getQ()
```
    A query for filtering the file results. See the "Search for Files" guide for supported syntax.
  - setQ
```
public Drive.Files.List setQ(java.lang.String q)
```
    A query for filtering the file results. See the "Search for Files" guide for supported syntax.
  - getSpaces
```
public java.lang.String getSpaces()
```
    A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. [default: drive]
  - setSpaces
```
public Drive.Files.List setSpaces(java.lang.String spaces)
```
    A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
  - getSupportsAllDrives
```
public java.lang.Boolean getSupportsAllDrives()
```
    Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. [default: false]
  - setSupportsAllDrives
```
public Drive.Files.List setSupportsAllDrives(java.lang.Boolean supportsAllDrives)
```
    Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
  - isSupportsAllDrives
```
public boolean isSupportsAllDrives()
```
    Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
    Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.
    
    This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.
    
    Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
  - getSupportsTeamDrives
```
public java.lang.Boolean getSupportsTeamDrives()
```
    Deprecated use supportsAllDrives instead. [default: false]
  - setSupportsTeamDrives
```
public Drive.Files.List setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)
```
    Deprecated use supportsAllDrives instead.
  - isSupportsTeamDrives
```
public boolean isSupportsTeamDrives()
```
    Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
    Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.
    
    This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.
    
    Deprecated use supportsAllDrives instead.
  - getTeamDriveId
```
public java.lang.String getTeamDriveId()
```
    Deprecated use driveId instead.
  - setTeamDriveId
```
public Drive.Files.List setTeamDriveId(java.lang.String teamDriveId)
```
    Deprecated use driveId instead.
  - set
```
public Drive.Files.List set(java.lang.String parameterName,
                            java.lang.Object value)
```
    Overrides:
    
    set in class DriveRequest<FileList>

Drive API v3 (revision 197)

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

getDriveId

setDriveId

getIncludeItemsFromAllDrives

setIncludeItemsFromAllDrives

isIncludeItemsFromAllDrives

getIncludeTeamDriveItems

setIncludeTeamDriveItems

isIncludeTeamDriveItems

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

getQ

setQ

getSpaces

setSpaces

getSupportsAllDrives

setSupportsAllDrives

isSupportsAllDrives

getSupportsTeamDrives

setSupportsTeamDrives

isSupportsTeamDrives

getTeamDriveId

setTeamDriveId

set