com.google.api.services.drive

Class Drive.Changes.Watch

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

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

All Implemented Interfaces:

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

Enclosing class:

Drive.Changes

public class Drive.Changes.Watch
extends DriveRequest<Channel>

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Watch(Channel content) Subscribe to changes for a user.

Method Summary

Modifier and Type	Method and Description
java.lang.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.
java.lang.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.
java.lang.Boolean	getIncludeSubscribed() Whether to include changes outside the My Drive hierarchy in the result.
java.lang.Boolean	getIncludeTeamDriveItems() Whether Team Drive files or changes should be included in results.
java.lang.Integer	getMaxResults() Maximum number of changes to return.
java.lang.String	getPageToken() The token for continuing a previous list request on the next page.
java.lang.String	getSpaces() A comma-separated list of spaces to query.
java.lang.Long	getStartChangeId() Deprecated - use pageToken instead.
java.lang.Boolean	getSupportsTeamDrives() Whether the requesting application supports Team Drives.
java.lang.String	getTeamDriveId() The Team Drive from which changes will be returned.
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	isIncludeSubscribed() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeTeamDriveItems() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsTeamDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Changes.Watch	set(java.lang.String parameterName, java.lang.Object value)
Drive.Changes.Watch	setAlt(java.lang.String alt) Data format for the response.
Drive.Changes.Watch	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Drive.Changes.Watch	setIncludeCorpusRemovals(java.lang.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.Watch	setIncludeDeleted(java.lang.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.Watch	setIncludeSubscribed(java.lang.Boolean includeSubscribed) Whether to include changes outside the My Drive hierarchy in the result.
Drive.Changes.Watch	setIncludeTeamDriveItems(java.lang.Boolean includeTeamDriveItems) Whether Team Drive files or changes should be included in results.
Drive.Changes.Watch	setKey(java.lang.String key) API key.
Drive.Changes.Watch	setMaxResults(java.lang.Integer maxResults) Maximum number of changes to return.
Drive.Changes.Watch	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Changes.Watch	setPageToken(java.lang.String pageToken) The token for continuing a previous list request on the next page.
Drive.Changes.Watch	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Changes.Watch	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
Drive.Changes.Watch	setSpaces(java.lang.String spaces) A comma-separated list of spaces to query.
Drive.Changes.Watch	setStartChangeId(java.lang.Long startChangeId) Deprecated - use pageToken instead.
Drive.Changes.Watch	setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives) Whether the requesting application supports Team Drives.
Drive.Changes.Watch	setTeamDriveId(java.lang.String teamDriveId) The Team Drive from which changes will be returned.
Drive.Changes.Watch	setUserIp(java.lang.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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Watch

protected Watch(Channel content)

Subscribe to changes for a user. Create a request for the method "changes.watch". 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:

content - the Channel

Since:

1.13

Method Detail

setAlt

public Drive.Changes.Watch setAlt(java.lang.String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<Channel>

setFields

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

setKey

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

setOauthToken

public Drive.Changes.Watch setOauthToken(java.lang.String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<Channel>

setPrettyPrint

public Drive.Changes.Watch setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<Channel>

setQuotaUser

public Drive.Changes.Watch setQuotaUser(java.lang.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<Channel>

setUserIp

public Drive.Changes.Watch setUserIp(java.lang.String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<Channel>

getIncludeCorpusRemovals

public java.lang.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.Watch setIncludeCorpusRemovals(java.lang.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 java.lang.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.Watch setIncludeDeleted(java.lang.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.

getIncludeSubscribed

public java.lang.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 will be omitted from the result. [default: true]

setIncludeSubscribed

public Drive.Changes.Watch setIncludeSubscribed(java.lang.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 will be 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 will be omitted from the result.

getIncludeTeamDriveItems

public java.lang.Boolean getIncludeTeamDriveItems()

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

setIncludeTeamDriveItems

public Drive.Changes.Watch setIncludeTeamDriveItems(java.lang.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.

getMaxResults

public java.lang.Integer getMaxResults()

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

setMaxResults

public Drive.Changes.Watch setMaxResults(java.lang.Integer maxResults)

Maximum number of changes to return.

getPageToken

public java.lang.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.Watch setPageToken(java.lang.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 java.lang.String getSpaces()

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

setSpaces

public Drive.Changes.Watch setSpaces(java.lang.String spaces)

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

getStartChangeId

public java.lang.Long getStartChangeId()

Deprecated - use pageToken instead.

setStartChangeId

public Drive.Changes.Watch setStartChangeId(java.lang.Long startChangeId)

Deprecated - use pageToken instead.

getSupportsTeamDrives

public java.lang.Boolean getSupportsTeamDrives()

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

setSupportsTeamDrives

public Drive.Changes.Watch setSupportsTeamDrives(java.lang.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 java.lang.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.Watch setTeamDriveId(java.lang.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.Watch set(java.lang.String parameterName,
                               java.lang.Object value)

Overrides:

set in class DriveRequest<Channel>