com.google.api.services.drive

Class Drive.Children.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<ChildList>

com.google.api.services.drive.Drive.Children.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Drive.Children

public class Drive.Children.List
extends DriveRequest<ChildList>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Drive.Children.List(java.lang.String folderId) Lists a folder's children.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getFolderId() The ID of the folder.
java.lang.Integer	getMaxResults() Maximum number of children to return.
java.lang.String	getOrderBy() A comma-separated list of sort keys.
java.lang.String	getPageToken() Page token for children.
java.lang.String	getQ() Query string for searching children.
Drive.Children.List	set(java.lang.String parameterName, java.lang.Object value)
Drive.Children.List	setAlt(java.lang.String alt) Data format for the response.
Drive.Children.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Drive.Children.List	setFolderId(java.lang.String folderId) The ID of the folder.
Drive.Children.List	setKey(java.lang.String key) API key.
Drive.Children.List	setMaxResults(java.lang.Integer maxResults) Maximum number of children to return.
Drive.Children.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Children.List	setOrderBy(java.lang.String orderBy) A comma-separated list of sort keys.
Drive.Children.List	setPageToken(java.lang.String pageToken) Page token for children.
Drive.Children.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Children.List	setQ(java.lang.String q) Query string for searching children.
Drive.Children.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Children.List	setUserIp(java.lang.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.Children.List

protected Drive.Children.List(java.lang.String folderId)

Lists a folder's children. Create a request for the method "children.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.

Parameters:

folderId - The ID of the folder.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ChildList>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ChildList>

Throws:

java.io.IOException

setAlt

public Drive.Children.List setAlt(java.lang.String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<ChildList>

setFields

public Drive.Children.List setFields(java.lang.String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<ChildList>

setKey

public Drive.Children.List setKey(java.lang.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<ChildList>

setOauthToken

public Drive.Children.List setOauthToken(java.lang.String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<ChildList>

setPrettyPrint

public Drive.Children.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<ChildList>

setQuotaUser

public Drive.Children.List setQuotaUser(java.lang.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<ChildList>

setUserIp

public Drive.Children.List setUserIp(java.lang.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<ChildList>

getFolderId

public java.lang.String getFolderId()

The ID of the folder.

setFolderId

public Drive.Children.List setFolderId(java.lang.String folderId)

The ID of the folder.

getOrderBy

public java.lang.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.Children.List setOrderBy(java.lang.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 java.lang.String getPageToken()

Page token for children.

setPageToken

public Drive.Children.List setPageToken(java.lang.String pageToken)

Page token for children.

getQ

public java.lang.String getQ()

Query string for searching children.

setQ

public Drive.Children.List setQ(java.lang.String q)

Query string for searching children.

getMaxResults

public java.lang.Integer getMaxResults()

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

setMaxResults

public Drive.Children.List setMaxResults(java.lang.Integer maxResults)

Maximum number of children to return.

set

public Drive.Children.List set(java.lang.String parameterName,
                      java.lang.Object value)

Overrides:

set in class DriveRequest<ChildList>