Drive.Children.List (Drive API v2-rev20230514-2.0.0)

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<ChildList>
        
        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<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
  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(String folderId)
Lists a folder's children.

Constructors
Modifier	Constructor and Description
`protected`	`List(String folderId)` Lists a folder's children.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getFolderId()` The ID of the folder.
`Integer`	`getMaxResults()` Maximum number of children to return.
`String`	`getOrderBy()` A comma-separated list of sort keys.
`String`	`getPageToken()` Page token for children.
`String`	`getQ()` Query string for searching children.
`Drive.Children.List`	`set(String parameterName, Object value)`
`Drive.Children.List`	`setAlt(String alt)` Data format for the response.
`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`	`setKey(String key)` API key.
`Drive.Children.List`	`setMaxResults(Integer maxResults)` Maximum number of children to return.
`Drive.Children.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Drive.Children.List`	`setOrderBy(String orderBy)` A comma-separated list of sort keys.
`Drive.Children.List`	`setPageToken(String pageToken)` Page token for children.
`Drive.Children.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Drive.Children.List`	`setQ(String q)` Query string for searching children.
`Drive.Children.List`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Drive.Children.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(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 IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ChildList>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ChildList>
    
    Throws:
    
    IOException
  - setAlt
```
public Drive.Children.List setAlt(String alt)
```
    Description copied from class: DriveRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DriveRequest<ChildList>
  - 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<ChildList>
  - setKey
```
public Drive.Children.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<ChildList>
  - setOauthToken
```
public Drive.Children.List setOauthToken(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(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(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<ChildList>
  - setUserIp
```
public Drive.Children.List setUserIp(String userIp)
```
    Description copied from class: DriveRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class DriveRequest<ChildList>
  - getFolderId
```
public String getFolderId()
```
    The ID of the folder.
  - setFolderId
```
public Drive.Children.List setFolderId(String folderId)
```
    The ID of the folder.
  - 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.
  - getOrderBy
```
public 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(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 String getPageToken()
```
    Page token for children.
  - setPageToken
```
public Drive.Children.List setPageToken(String pageToken)
```
    Page token for children.
  - getQ
```
public String getQ()
```
    Query string for searching children.
  - setQ
```
public Drive.Children.List setQ(String q)
```
    Query string for searching children.
  - set
```
public Drive.Children.List set(String parameterName,
                               Object value)
```
    Overrides:
    
    set in class DriveRequest<ChildList>

Class Drive.Children.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

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

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getFolderId

setFolderId

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getQ

setQ

set