Drive API v2 (revision 66)



com.google.api.services.drive
Class Drive.Files.List

java.lang.Object
  extended by java.util.AbstractMap<String,Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
              extended by com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  extended by com.google.api.services.drive.DriveRequest<FileList>
                      extended by 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
protected Drive.Files.List()
          Lists the user's files.
 
Method Summary
 HttpRequest buildHttpRequestUsingHead()
           
 HttpResponse executeUsingHead()
           
 Integer getMaxResults()
          Maximum number of files to return.
 String getPageToken()
          Page token for files.
 String getProjection()
          This parameter is deprecated and has no function.
 String getQ()
          Query string for searching files.
 Drive.Files.List setAlt(String alt)
          Data format for the response.
 Drive.Files.List setFields(String fields)
          Selector specifying which fields to include in a partial response.
 Drive.Files.List setKey(String key)
          API key.
 Drive.Files.List setMaxResults(Integer maxResults)
          Maximum number of files to return.
 Drive.Files.List setOauthToken(String oauthToken)
          OAuth 2.0 token for the current user.
 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 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, 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, 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
 

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(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>

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()
This parameter is deprecated and has no function.


setProjection

public Drive.Files.List setProjection(String projection)
This parameter is deprecated and has no function.


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.