Drive.Files.List (Google Drive API v3-rev20241027-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,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:

Cloneable, Map<String,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
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, 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()`
`String`	`getCorpora()` Bodies of items (files/documents) to which the query applies.
`String`	`getCorpus()` Deprecated: The source of files to list.
`String`	`getDriveId()` ID of the shared drive to search.
`Boolean`	`getIncludeItemsFromAllDrives()` Whether both My Drive and shared drive items should be included in results.
`String`	`getIncludeLabels()` A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
`String`	`getIncludePermissionsForView()` Specifies which additional view's permissions to include in the response.
`Boolean`	`getIncludeTeamDriveItems()` Deprecated: Use `includeItemsFromAllDrives` instead.
`String`	`getOrderBy()` A comma-separated list of sort keys.
`Integer`	`getPageSize()` The maximum number of files to return per page.
`String`	`getPageToken()` The token for continuing a previous list request on the next page.
`String`	`getQ()` A query for filtering the file results.
`String`	`getSpaces()` A comma-separated list of spaces to query within the corpora.
`Boolean`	`getSupportsAllDrives()` Whether the requesting application supports both My Drives and shared drives.
`Boolean`	`getSupportsTeamDrives()` Deprecated: Use `supportsAllDrives` instead.
`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(String parameterName, Object value)`
`Drive.Files.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Drive.Files.List`	`setAccessToken(String accessToken)` OAuth access token.
`Drive.Files.List`	`setAlt(String alt)` Data format for response.
`Drive.Files.List`	`setCallback(String callback)` JSONP
`Drive.Files.List`	`setCorpora(String corpora)` Bodies of items (files/documents) to which the query applies.
`Drive.Files.List`	`setCorpus(String corpus)` Deprecated: The source of files to list.
`Drive.Files.List`	`setDriveId(String driveId)` ID of the shared drive to search.
`Drive.Files.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Drive.Files.List`	`setIncludeItemsFromAllDrives(Boolean includeItemsFromAllDrives)` Whether both My Drive and shared drive items should be included in results.
`Drive.Files.List`	`setIncludeLabels(String includeLabels)` A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
`Drive.Files.List`	`setIncludePermissionsForView(String includePermissionsForView)` Specifies which additional view's permissions to include in the response.
`Drive.Files.List`	`setIncludeTeamDriveItems(Boolean includeTeamDriveItems)` Deprecated: Use `includeItemsFromAllDrives` instead.
`Drive.Files.List`	`setKey(String key)` API key.
`Drive.Files.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Drive.Files.List`	`setOrderBy(String orderBy)` A comma-separated list of sort keys.
`Drive.Files.List`	`setPageSize(Integer pageSize)` The maximum number of files to return per page.
`Drive.Files.List`	`setPageToken(String pageToken)` The token for continuing a previous list request on the next page.
`Drive.Files.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Drive.Files.List`	`setQ(String q)` A query for filtering the file results.
`Drive.Files.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Drive.Files.List`	`setSpaces(String spaces)` A comma-separated list of spaces to query within the corpora.
`Drive.Files.List`	`setSupportsAllDrives(Boolean supportsAllDrives)` Whether the requesting application supports both My Drives and shared drives.
`Drive.Files.List`	`setSupportsTeamDrives(Boolean supportsTeamDrives)` Deprecated: Use `supportsAllDrives` instead.
`Drive.Files.List`	`setTeamDriveId(String teamDriveId)` Deprecated: Use `driveId` instead.
`Drive.Files.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Drive.Files.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.drive.DriveRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
  - List
```
protected List()
```
    Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. 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 IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<FileList>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<FileList>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Drive.Files.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DriveRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DriveRequest<FileList>
  - setAccessToken
```
public Drive.Files.List setAccessToken(String accessToken)
```
    Description copied from class: DriveRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DriveRequest<FileList>
  - setAlt
```
public Drive.Files.List setAlt(String alt)
```
    Description copied from class: DriveRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DriveRequest<FileList>
  - setCallback
```
public Drive.Files.List setCallback(String callback)
```
    Description copied from class: DriveRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DriveRequest<FileList>
  - setFields
```
public Drive.Files.List setFields(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(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(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(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(String quotaUser)
```
    Description copied from class: DriveRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class DriveRequest<FileList>
  - setUploadType
```
public Drive.Files.List setUploadType(String uploadType)
```
    Description copied from class: DriveRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DriveRequest<FileList>
  - setUploadProtocol
```
public Drive.Files.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DriveRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DriveRequest<FileList>
  - getCorpora
```
public 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. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.
  - setCorpora
```
public Drive.Files.List setCorpora(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. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.
  - getCorpus
```
public String getCorpus()
```
    Deprecated: The source of files to list. Use 'corpora' instead.
  - setCorpus
```
public Drive.Files.List setCorpus(String corpus)
```
    Deprecated: The source of files to list. Use 'corpora' instead.
  - getDriveId
```
public String getDriveId()
```
    ID of the shared drive to search.
  - setDriveId
```
public Drive.Files.List setDriveId(String driveId)
```
    ID of the shared drive to search.
  - getIncludeItemsFromAllDrives
```
public Boolean getIncludeItemsFromAllDrives()
```
    Whether both My Drive and shared drive items should be included in results. [default: false]
  - setIncludeItemsFromAllDrives
```
public Drive.Files.List setIncludeItemsFromAllDrives(Boolean includeItemsFromAllDrives)
```
    Whether both My Drive and shared drive items should be included in 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.
    
    Whether both My Drive and shared drive items should be included in results.
  - getIncludeLabels
```
public String getIncludeLabels()
```
    A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
  - setIncludeLabels
```
public Drive.Files.List setIncludeLabels(String includeLabels)
```
    A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
  - getIncludePermissionsForView
```
public String getIncludePermissionsForView()
```
    Specifies which additional view's permissions to include in the response. Only 'published' is supported.
  - setIncludePermissionsForView
```
public Drive.Files.List setIncludePermissionsForView(String includePermissionsForView)
```
    Specifies which additional view's permissions to include in the response. Only 'published' is supported.
  - getIncludeTeamDriveItems
```
public Boolean getIncludeTeamDriveItems()
```
    Deprecated: Use `includeItemsFromAllDrives` instead. [default: false]
  - setIncludeTeamDriveItems
```
public Drive.Files.List setIncludeTeamDriveItems(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 String getOrderBy()
```
    A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.
  - setOrderBy
```
public Drive.Files.List setOrderBy(String orderBy)
```
    A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.
  - getPageSize
```
public 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(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 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(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 String getQ()
```
    A query for filtering the file results. See the "Search for files & folders" guide for supported syntax.
  - setQ
```
public Drive.Files.List setQ(String q)
```
    A query for filtering the file results. See the "Search for files & folders" guide for supported syntax.
  - getSpaces
```
public String getSpaces()
```
    A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. [default: drive]
  - setSpaces
```
public Drive.Files.List setSpaces(String spaces)
```
    A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
  - getSupportsAllDrives
```
public Boolean getSupportsAllDrives()
```
    Whether the requesting application supports both My Drives and shared drives. [default: false]
  - setSupportsAllDrives
```
public Drive.Files.List setSupportsAllDrives(Boolean supportsAllDrives)
```
    Whether the requesting application supports both My Drives and 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.
    
    Whether the requesting application supports both My Drives and shared drives.
  - getSupportsTeamDrives
```
public Boolean getSupportsTeamDrives()
```
    Deprecated: Use `supportsAllDrives` instead. [default: false]
  - setSupportsTeamDrives
```
public Drive.Files.List setSupportsTeamDrives(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 String getTeamDriveId()
```
    Deprecated: Use `driveId` instead.
  - setTeamDriveId
```
public Drive.Files.List setTeamDriveId(String teamDriveId)
```
    Deprecated: Use `driveId` instead.
  - set
```
public Drive.Files.List set(String parameterName,
                            Object value)
```
    Overrides:
    
    set in class DriveRequest<FileList>

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

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getCorpora

setCorpora

getCorpus

setCorpus

getDriveId

setDriveId

getIncludeItemsFromAllDrives

setIncludeItemsFromAllDrives

isIncludeItemsFromAllDrives

getIncludeLabels

setIncludeLabels

getIncludePermissionsForView

setIncludePermissionsForView

getIncludeTeamDriveItems

setIncludeTeamDriveItems

isIncludeTeamDriveItems

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

getQ

setQ

getSpaces

setSpaces

getSupportsAllDrives

setSupportsAllDrives

isSupportsAllDrives

getSupportsTeamDrives

setSupportsTeamDrives

isSupportsTeamDrives

getTeamDriveId

setTeamDriveId

set