com.google.api.services.drive

Class Drive.Changes.List

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Changes

public class Drive.Changes.List
extends DriveRequest<ChangeList>

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 pageToken) Lists the changes for a user or Team Drive.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Boolean	getIncludeCorpusRemovals() Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
Boolean	getIncludeRemoved() Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
Boolean	getIncludeTeamDriveItems() Whether Team Drive files or changes should be included in results.
Integer	getPageSize() The maximum number of changes to return per page.
String	getPageToken() The token for continuing a previous list request on the next page.
Boolean	getRestrictToMyDrive() Whether to restrict the results to changes inside the My Drive hierarchy.
String	getSpaces() A comma-separated list of spaces to query within the user corpus.
Boolean	getSupportsTeamDrives() Whether the requesting application supports Team Drives.
String	getTeamDriveId() The Team Drive from which changes will be returned.
boolean	isIncludeCorpusRemovals() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeRemoved() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeTeamDriveItems() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isRestrictToMyDrive() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsTeamDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Changes.List	set(String parameterName, Object value)
Drive.Changes.List	setAlt(String alt) Data format for the response.
Drive.Changes.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Changes.List	setIncludeCorpusRemovals(Boolean includeCorpusRemovals) Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
Drive.Changes.List	setIncludeRemoved(Boolean includeRemoved) Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
Drive.Changes.List	setIncludeTeamDriveItems(Boolean includeTeamDriveItems) Whether Team Drive files or changes should be included in results.
Drive.Changes.List	setKey(String key) API key.
Drive.Changes.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Changes.List	setPageSize(Integer pageSize) The maximum number of changes to return per page.
Drive.Changes.List	setPageToken(String pageToken) The token for continuing a previous list request on the next page.
Drive.Changes.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Changes.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Drive.Changes.List	setRestrictToMyDrive(Boolean restrictToMyDrive) Whether to restrict the results to changes inside the My Drive hierarchy.
Drive.Changes.List	setSpaces(String spaces) A comma-separated list of spaces to query within the user corpus.
Drive.Changes.List	setSupportsTeamDrives(Boolean supportsTeamDrives) Whether the requesting application supports Team Drives.
Drive.Changes.List	setTeamDriveId(String teamDriveId) The Team Drive from which changes will be returned.
Drive.Changes.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, 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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

List

protected List(String pageToken)

Lists the changes for a user or Team Drive. Create a request for the method "changes.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:

pageToken - The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Drive.Changes.List setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<ChangeList>

setFields

public Drive.Changes.List setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<ChangeList>

setKey

public Drive.Changes.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<ChangeList>

setOauthToken

public Drive.Changes.List setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<ChangeList>

setPrettyPrint

public Drive.Changes.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<ChangeList>

setQuotaUser

public Drive.Changes.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<ChangeList>

setUserIp

public Drive.Changes.List setUserIp(String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<ChangeList>

getPageToken

public String getPageToken()

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.

setPageToken

public Drive.Changes.List setPageToken(String pageToken)

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.

getIncludeCorpusRemovals

public Boolean getIncludeCorpusRemovals()

Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. [default: false]

setIncludeCorpusRemovals

public Drive.Changes.List setIncludeCorpusRemovals(Boolean includeCorpusRemovals)

Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.

isIncludeCorpusRemovals

public boolean isIncludeCorpusRemovals()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.

getIncludeRemoved

public Boolean getIncludeRemoved()

Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. [default: true]

setIncludeRemoved

public Drive.Changes.List setIncludeRemoved(Boolean includeRemoved)

Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

isIncludeRemoved

public boolean isIncludeRemoved()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

getIncludeTeamDriveItems

public Boolean getIncludeTeamDriveItems()

Whether Team Drive files or changes should be included in results. [default: false]

setIncludeTeamDriveItems

public Drive.Changes.List setIncludeTeamDriveItems(Boolean includeTeamDriveItems)

Whether Team Drive files or changes should be included in results.

isIncludeTeamDriveItems

public boolean isIncludeTeamDriveItems()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether Team Drive files or changes should be included in results.

getPageSize

public Integer getPageSize()

The maximum number of changes to return per page. [default: 100] [minimum: 1] [maximum: 1000]

setPageSize

public Drive.Changes.List setPageSize(Integer pageSize)

The maximum number of changes to return per page.

getRestrictToMyDrive

public Boolean getRestrictToMyDrive()

Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. [default: false]

setRestrictToMyDrive

public Drive.Changes.List setRestrictToMyDrive(Boolean restrictToMyDrive)

Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.

isRestrictToMyDrive

public boolean isRestrictToMyDrive()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.

getSpaces

public String getSpaces()

A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. [default: drive]

setSpaces

public Drive.Changes.List setSpaces(String spaces)

A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

getSupportsTeamDrives

public Boolean getSupportsTeamDrives()

Whether the requesting application supports Team Drives. [default: false]

setSupportsTeamDrives

public Drive.Changes.List setSupportsTeamDrives(Boolean supportsTeamDrives)

Whether the requesting application supports Team Drives.

isSupportsTeamDrives

public boolean isSupportsTeamDrives()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether the requesting application supports Team Drives.

getTeamDriveId

public String getTeamDriveId()

The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.

setTeamDriveId

public Drive.Changes.List setTeamDriveId(String teamDriveId)

The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.

set

public Drive.Changes.List set(String parameterName,
                              Object value)

Overrides:

set in class DriveRequest<ChangeList>