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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getCorpora() Groupings of files to which the query applies.
String	getCorpus() The body of items (files/documents) to which the query applies.
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.
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	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	setAlt(String alt) Data format for the response.
Drive.Files.List	setCorpora(String corpora) Groupings of files 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	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	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) An opaque string that represents a user for quota purposes.
Drive.Files.List	setSpaces(String spaces) A comma-separated list of spaces to query.
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	setUserIp(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, 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. 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

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

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(String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<FileList>

getCorpora

public String getCorpora()

Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.

setCorpora

public Drive.Files.List setCorpora(String corpora)

Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', 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.

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.

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', '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(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 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' and 'appDataFolder'.

setSpaces

public Drive.Files.List setSpaces(String spaces)

A comma-separated list of spaces to query. 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>