com.google.api.services.drive

Class Drive.Files.List

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

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

Modifier	Constructor and Description
protected	Drive.Files.List() Lists the user's files.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getCorpora() Comma-separated list of bodies of items (files/documents) to which the query applies.
String	getCorpus() The body of items (files/documents) to which the query applies.
Boolean	getIncludeTeamDriveItems() Whether Team Drive items should be included in results.
Integer	getMaxResults() The maximum number of files to return per page.
String	getOrderBy() A comma-separated list of sort keys.
String	getPageToken() Page token for files.
String	getProjection() This parameter is deprecated and has no function.
String	getQ() Query string for searching files.
String	getSpaces() A comma-separated list of spaces to query.
Boolean	getSupportsTeamDrives() Whether the requesting application supports Team Drives.
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(String parameterName, Object value)
Drive.Files.List	setAlt(String alt) Data format for the response.
Drive.Files.List	setCorpora(String corpora) Comma-separated list of bodies of items (files/documents) to which the query applies.
Drive.Files.List	setCorpus(String corpus) The body of items (files/documents) to which the query applies.
Drive.Files.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.List	setIncludeTeamDriveItems(Boolean includeTeamDriveItems) Whether Team Drive items should be included in results.
Drive.Files.List	setKey(String key) API key.
Drive.Files.List	setMaxResults(Integer maxResults) The maximum number of files to return per page.
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	setPageToken(String pageToken) Page token for files.
Drive.Files.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.List	setProjection(String projection) This parameter is deprecated and has no function.
Drive.Files.List	setQ(String q) Query string for searching files.
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.
Drive.Files.List	setSupportsTeamDrives(Boolean supportsTeamDrives) Whether the requesting application supports Team Drives.
Drive.Files.List	setTeamDriveId(String teamDriveId) ID of Team Drive to search.
Drive.Files.List	setUserIp(String userIp) IP address of the site where the request originates.

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

Constructor Detail

Drive.Files.List

protected Drive.Files.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 HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<FileList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<FileList>

Throws:

IOException

setAlt

public Drive.Files.List setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt 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 userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<FileList>

setUserIp

public Drive.Files.List setUserIp(String userIp)

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<FileList>

getCorpora

public 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(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 String getCorpus()

The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.

setCorpus

public Drive.Files.List setCorpus(String corpus)

The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.

getIncludeTeamDriveItems

public Boolean getIncludeTeamDriveItems()

Whether Team Drive items should be included in results. [default: false]

setIncludeTeamDriveItems

public Drive.Files.List setIncludeTeamDriveItems(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 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(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 String getOrderBy()

A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. 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(String orderBy)

A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. 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 String getPageToken()

Page token for files.

setPageToken

public Drive.Files.List setPageToken(String pageToken)

Page token for files.

getProjection

public String getProjection()

This parameter is deprecated and has no function.

setProjection

public Drive.Files.List setProjection(String projection)

This parameter is deprecated and has no function.

getQ

public String getQ()

Query string for searching files.

setQ

public Drive.Files.List setQ(String q)

Query string for searching files.

getSpaces

public String getSpaces()

A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.

setSpaces

public Drive.Files.List setSpaces(String spaces)

A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.

getSupportsTeamDrives

public Boolean getSupportsTeamDrives()

Whether the requesting application supports Team Drives. [default: false]

setSupportsTeamDrives

public Drive.Files.List setSupportsTeamDrives(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 String getTeamDriveId()

ID of Team Drive to search.

setTeamDriveId

public Drive.Files.List setTeamDriveId(String teamDriveId)

ID of Team Drive to search.

set

public Drive.Files.List set(String parameterName,
                   Object value)

Overrides:

set in class DriveRequest<FileList>