target.apidocs.com.google.api.services.drive.model.FileList.html Maven / Gradle / Ivy







FileList (Drive API v2-rev20180830-1.26.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.drive.model
Class FileList



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.drive.model.FileList













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class FileList
extends com.google.api.client.json.GenericJson
A list of files.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Drive API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












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>








Constructor Summary

Constructors 

Constructor and Description


FileList() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


FileList
clone() 


String
getEtag()
The ETag of the list.



Boolean
getIncompleteSearch()
Whether the search process was incomplete.



List<File>
getItems()
The list of files.



String
getKind()
This is always drive#fileList.



String
getNextLink()
A link to the next page of files.



String
getNextPageToken()
The page token for the next page of files.



String
getSelfLink()
A link back to this list.



FileList
set(String fieldName,
   Object value) 


FileList
setEtag(String etag)
The ETag of the list.



FileList
setIncompleteSearch(Boolean incompleteSearch)
Whether the search process was incomplete.



FileList
setItems(List<File> items)
The list of files.



FileList
setKind(String kind)
This is always drive#fileList.



FileList
setNextLink(String nextLink)
A link to the next page of files.



FileList
setNextPageToken(String nextPageToken)
The page token for the next page of files.



FileList
setSelfLink(String selfLink)
A link back to this list.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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





FileList
public FileList()









Method Detail





getEtag
public String getEtag()
The ETag of the list.

Returns:
value or null for none








setEtag
public FileList setEtag(String etag)
The ETag of the list.

Parameters:
etag - etag or null for none








getIncompleteSearch
public Boolean getIncompleteSearch()
Whether the search process was incomplete. If true, then some search results may be missing,
 since all documents were not searched. This may occur when searching multiple Team Drives with
 the "default,allTeamDrives" corpora, but all corpora could not be searched. When this happens,
 it is suggested that clients narrow their query by choosing a different corpus such as
 "default" or "teamDrive".

Returns:
value or null for none








setIncompleteSearch
public FileList setIncompleteSearch(Boolean incompleteSearch)
Whether the search process was incomplete. If true, then some search results may be missing,
 since all documents were not searched. This may occur when searching multiple Team Drives with
 the "default,allTeamDrives" corpora, but all corpora could not be searched. When this happens,
 it is suggested that clients narrow their query by choosing a different corpus such as
 "default" or "teamDrive".

Parameters:
incompleteSearch - incompleteSearch or null for none








getItems
public List<File> getItems()
The list of files. If nextPageToken is populated, then this list may be incomplete and an
 additional page of results should be fetched.

Returns:
value or null for none








setItems
public FileList setItems(List<File> items)
The list of files. If nextPageToken is populated, then this list may be incomplete and an
 additional page of results should be fetched.

Parameters:
items - items or null for none








getKind
public String getKind()
This is always drive#fileList.

Returns:
value or null for none








setKind
public FileList setKind(String kind)
This is always drive#fileList.

Parameters:
kind - kind or null for none








getNextLink
public String getNextLink()
A link to the next page of files.

Returns:
value or null for none








setNextLink
public FileList setNextLink(String nextLink)
A link to the next page of files.

Parameters:
nextLink - nextLink or null for none








getNextPageToken
public String getNextPageToken()
The page token for the next page of files. This will be absent if the end of the files list has
 been reached. If the token is rejected for any reason, it should be discarded, and pagination
 should be restarted from the first page of results.

Returns:
value or null for none








setNextPageToken
public FileList setNextPageToken(String nextPageToken)
The page token for the next page of files. This will be absent if the end of the files list has
 been reached. If the token is rejected for any reason, it should be discarded, and pagination
 should be restarted from the first page of results.

Parameters:
nextPageToken - nextPageToken or null for none








getSelfLink
public String getSelfLink()
A link back to this list.

Returns:
value or null for none








setSelfLink
public FileList setSelfLink(String selfLink)
A link back to this list.

Parameters:
selfLink - selfLink or null for none








set
public FileList set(String fieldName,
                    Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public FileList clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2018 Google. All rights reserved.

Modifier and Type	Method and Description
`FileList`	`clone()`
`String`	`getEtag()` The ETag of the list.
`Boolean`	`getIncompleteSearch()` Whether the search process was incomplete.
`List<File>`	`getItems()` The list of files.
`String`	`getKind()` This is always drive#fileList.
`String`	`getNextLink()` A link to the next page of files.
`String`	`getNextPageToken()` The page token for the next page of files.
`String`	`getSelfLink()` A link back to this list.
`FileList`	`set(String fieldName, Object value)`
`FileList`	`setEtag(String etag)` The ETag of the list.
`FileList`	`setIncompleteSearch(Boolean incompleteSearch)` Whether the search process was incomplete.
`FileList`	`setItems(List<File> items)` The list of files.
`FileList`	`setKind(String kind)` This is always drive#fileList.
`FileList`	`setNextLink(String nextLink)` A link to the next page of files.
`FileList`	`setNextPageToken(String nextPageToken)` The page token for the next page of files.
`FileList`	`setSelfLink(String selfLink)` A link back to this list.