Drive API v2 (revision 1)

com.google.api.services.drive
Class Drive.Children.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.Children.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Children

public class Drive.Children.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

ChildList	execute() Sends the "list" request to the Drive server.
String	getFolderId() The ID of the folder.
Integer	getMaxResults() Maximum number of children to return.
String	getPageToken() Page token for children.
String	getQ() Query string for searching children.
void	queue(BatchRequest batch, JsonBatchCallback<ChildList> callback) Queues the "list" request to the Drive server into the given batch request.
Drive.Children.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Children.List	setFolderId(String folderId) The ID of the folder.
Drive.Children.List	setMaxResults(Integer maxResults) Maximum number of children to return.
Drive.Children.List	setPageToken(String pageToken) Page token for children.
Drive.Children.List	setQ(String q) Query string for searching children.

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 ChildList execute()
                  throws IOException

Sends the "list" request to the Drive server.

Returns:

the ChildList response

Throws:

IOException - if the request fails

queue

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

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

Example usage:

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

           public void onSuccess(ChildList 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.Children.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

getFolderId

public String getFolderId()

The ID of the folder.

setFolderId

public Drive.Children.List setFolderId(String folderId)

The ID of the folder.

getQ

public String getQ()

Query string for searching children.

setQ

public Drive.Children.List setQ(String q)

Query string for searching children.

getPageToken

public String getPageToken()

Page token for children.

setPageToken

public Drive.Children.List setPageToken(String pageToken)

Page token for children.

getMaxResults

public Integer getMaxResults()

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

setMaxResults

public Drive.Children.List setMaxResults(Integer maxResults)

Maximum number of children to return.