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

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() Lists the changes for a user or shared drive.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getDriveId() The shared drive from which changes are returned.
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	getIncludeDeleted() Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
Boolean	getIncludeItemsFromAllDrives() Whether both My Drive and shared drive items should be included in results.
String	getIncludePermissionsForView() Specifies which additional view's permissions to include in the response.
Boolean	getIncludeSubscribed() Whether to include changes outside the My Drive hierarchy in the result.
Boolean	getIncludeTeamDriveItems() Deprecated use includeItemsFromAllDrives instead.
Integer	getMaxResults() Maximum number of changes to return.
String	getPageToken() The token for continuing a previous list request on the next page.
String	getSpaces() A comma-separated list of spaces to query.
Long	getStartChangeId() Deprecated - use pageToken instead.
Boolean	getSupportsAllDrives() Whether the requesting application supports both My Drives and shared drives.
Boolean	getSupportsTeamDrives() Deprecated use supportsAllDrives instead.
String	getTeamDriveId() Deprecated use driveId instead.
boolean	isIncludeCorpusRemovals() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeDeleted() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeItemsFromAllDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeSubscribed() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeTeamDriveItems() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsAllDrives() 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	setDriveId(String driveId) The shared drive from which changes are returned.
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	setIncludeDeleted(Boolean includeDeleted) 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	setIncludeItemsFromAllDrives(Boolean includeItemsFromAllDrives) Whether both My Drive and shared drive items should be included in results.
Drive.Changes.List	setIncludePermissionsForView(String includePermissionsForView) Specifies which additional view's permissions to include in the response.
Drive.Changes.List	setIncludeSubscribed(Boolean includeSubscribed) Whether to include changes outside the My Drive hierarchy in the result.
Drive.Changes.List	setIncludeTeamDriveItems(Boolean includeTeamDriveItems) Deprecated use includeItemsFromAllDrives instead.
Drive.Changes.List	setKey(String key) API key.
Drive.Changes.List	setMaxResults(Integer maxResults) Maximum number of changes to return.
Drive.Changes.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
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	setSpaces(String spaces) A comma-separated list of spaces to query.
Drive.Changes.List	setStartChangeId(Long startChangeId) Deprecated - use pageToken instead.
Drive.Changes.List	setSupportsAllDrives(Boolean supportsAllDrives) Whether the requesting application supports both My Drives and shared drives.
Drive.Changes.List	setSupportsTeamDrives(Boolean supportsTeamDrives) Deprecated use supportsAllDrives instead.
Drive.Changes.List	setTeamDriveId(String teamDriveId) Deprecated use driveId instead.
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, 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()

Lists the changes for a user or shared 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.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ChangeList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class 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>

getDriveId

public String getDriveId()

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

setDriveId

public Drive.Changes.List setDriveId(String driveId)

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

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.

getIncludeDeleted

public Boolean getIncludeDeleted()

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]

setIncludeDeleted

public Drive.Changes.List setIncludeDeleted(Boolean includeDeleted)

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

isIncludeDeleted

public boolean isIncludeDeleted()

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.

getIncludeItemsFromAllDrives

public Boolean getIncludeItemsFromAllDrives()

Whether both My Drive and shared drive items should be included in results. [default: false]

setIncludeItemsFromAllDrives

public Drive.Changes.List setIncludeItemsFromAllDrives(Boolean includeItemsFromAllDrives)

Whether both My Drive and shared drive items should be included in results.

isIncludeItemsFromAllDrives

public boolean isIncludeItemsFromAllDrives()

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 both My Drive and shared drive items should be included in results.

getIncludePermissionsForView

public String getIncludePermissionsForView()

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

setIncludePermissionsForView

public Drive.Changes.List setIncludePermissionsForView(String includePermissionsForView)

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

getIncludeSubscribed

public Boolean getIncludeSubscribed()

Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. [default: true]

setIncludeSubscribed

public Drive.Changes.List setIncludeSubscribed(Boolean includeSubscribed)

Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result.

isIncludeSubscribed

public boolean isIncludeSubscribed()

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 outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result.

getIncludeTeamDriveItems

public Boolean getIncludeTeamDriveItems()

Deprecated use includeItemsFromAllDrives instead. [default: false]

setIncludeTeamDriveItems

public Drive.Changes.List setIncludeTeamDriveItems(Boolean includeTeamDriveItems)

Deprecated use includeItemsFromAllDrives instead.

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.

Deprecated use includeItemsFromAllDrives instead.

getMaxResults

public Integer getMaxResults()

Maximum number of changes to return. [default: 100] [minimum: 1]

setMaxResults

public Drive.Changes.List setMaxResults(Integer maxResults)

Maximum number of changes to return.

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.

getSpaces

public String getSpaces()

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

setSpaces

public Drive.Changes.List setSpaces(String spaces)

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

getStartChangeId

public Long getStartChangeId()

Deprecated - use pageToken instead.

setStartChangeId

public Drive.Changes.List setStartChangeId(Long startChangeId)

Deprecated - use pageToken instead.

getSupportsAllDrives

public Boolean getSupportsAllDrives()

Whether the requesting application supports both My Drives and shared drives. [default: false]

setSupportsAllDrives

public Drive.Changes.List setSupportsAllDrives(Boolean supportsAllDrives)

Whether the requesting application supports both My Drives and shared drives.

isSupportsAllDrives

public boolean isSupportsAllDrives()

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 both My Drives and shared drives.

getSupportsTeamDrives

public Boolean getSupportsTeamDrives()

Deprecated use supportsAllDrives instead. [default: false]

setSupportsTeamDrives

public Drive.Changes.List setSupportsTeamDrives(Boolean supportsTeamDrives)

Deprecated use supportsAllDrives instead.

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.

Deprecated use supportsAllDrives instead.

getTeamDriveId

public String getTeamDriveId()

Deprecated use driveId instead.

setTeamDriveId

public Drive.Changes.List setTeamDriveId(String teamDriveId)

Deprecated use driveId instead.

set

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

Overrides:

set in class DriveRequest<ChangeList>