Drive API v2 (revision 1)

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.http.json.JsonHttpRequest
              com.google.api.services.drive.DriveRequest
                  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

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>

Method Summary

FileList	execute() Sends the "list" request to the Drive server.
Integer	getMaxResults() Maximum number of files to return.
String	getPageToken() Page token for files.
String	getProjection() Restrict information returned for simplicity and optimization.
String	getQ() Query string for searching files.
void	queue(BatchRequest batch, JsonBatchCallback<FileList> callback) Queues the "list" request to the Drive server into the given batch request.
Drive.Files.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.List	setMaxResults(Integer maxResults) Maximum number of files to return.
Drive.Files.List	setPageToken(String pageToken) Page token for files.
Drive.Files.List	setProjection(String projection) Restrict information returned for simplicity and optimization.
Drive.Files.List	setQ(String q) Query string for searching files.

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

getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setAlt, setKey, setOauthToken, setPrettyPrint, setQuotaUser, setUserIp

Methods inherited from class com.google.api.client.http.json.JsonHttpRequest

buildHttpRequest, buildHttpRequestUrl, download, executeAsInputStream, executeUnparsed, getClient, getEnableGZipContent, getJsonContent, getLastResponseHeaders, getMethod, getRequestHeaders, getUriTemplate, setEnableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, 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

Method Detail

execute

public FileList execute()
                 throws IOException

Sends the "list" request to the Drive server.

Returns:

the FileList response

Throws:

IOException - if the request fails

queue

public void queue(BatchRequest batch,
                  JsonBatchCallback<FileList> callback)
           throws IOException

Queues the "list" request to the Drive server into the given batch request.

Example usage:

         request.queue(batchRequest, new JsonBatchCallback<FileList>() {

           public void onSuccess(FileList content, GoogleHeaders responseHeaders) {
             log("Success");
           }

           public void onFailure(GoogleJsonError e, GoogleHeaders responseHeaders) {
             log(e.getMessage());
           }
         });
 

Parameters:

batch - a single batch of requests

callback - batch callback

Throws:

IOException

Since:

1.6

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

Since:

1.7

getQ

public String getQ()

Query string for searching files.

setQ

public Drive.Files.List setQ(String q)

Query string for searching files.

getPageToken

public String getPageToken()

Page token for files.

setPageToken

public Drive.Files.List setPageToken(String pageToken)

Page token for files.

getProjection

public String getProjection()

Restrict information returned for simplicity and optimization.

setProjection

public Drive.Files.List setProjection(String projection)

Restrict information returned for simplicity and optimization.

getMaxResults

public Integer getMaxResults()

Maximum number of files to return. [default: 100] [minimum: 0]

setMaxResults

public Drive.Files.List setMaxResults(Integer maxResults)

Maximum number of files to return.