com.google.api.services.drive

Class Drive.Changes.Watch

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

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

All Implemented Interfaces:

Cloneable, Map<String,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

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Watch(String pageToken, Channel content) Subscribes to changes for a user.

Method Summary

Modifier and Type	Method and Description
String	getDriveId() The shared drive from which changes will be 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	getIncludeItemsFromAllDrives() Whether both My Drive and shared drive items should be included in results.
String	getIncludeLabels() A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
String	getIncludePermissionsForView() Specifies which additional view's permissions to include in the response.
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() Deprecated: Use `includeItemsFromAllDrives` instead.
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 corpora.
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	isIncludeItemsFromAllDrives() 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	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.Watch	set(String parameterName, Object value)
Drive.Changes.Watch	set$Xgafv(String $Xgafv) V1 error format.
Drive.Changes.Watch	setAccessToken(String accessToken) OAuth access token.
Drive.Changes.Watch	setAlt(String alt) Data format for response.
Drive.Changes.Watch	setCallback(String callback) JSONP
Drive.Changes.Watch	setDriveId(String driveId) The shared drive from which changes will be returned.
Drive.Changes.Watch	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Changes.Watch	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.Watch	setIncludeItemsFromAllDrives(Boolean includeItemsFromAllDrives) Whether both My Drive and shared drive items should be included in results.
Drive.Changes.Watch	setIncludeLabels(String includeLabels) A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
Drive.Changes.Watch	setIncludePermissionsForView(String includePermissionsForView) Specifies which additional view's permissions to include in the response.
Drive.Changes.Watch	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.Watch	setIncludeTeamDriveItems(Boolean includeTeamDriveItems) Deprecated: Use `includeItemsFromAllDrives` instead.
Drive.Changes.Watch	setKey(String key) API key.
Drive.Changes.Watch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Changes.Watch	setPageSize(Integer pageSize) The maximum number of changes to return per page.
Drive.Changes.Watch	setPageToken(String pageToken) The token for continuing a previous list request on the next page.
Drive.Changes.Watch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Changes.Watch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Changes.Watch	setRestrictToMyDrive(Boolean restrictToMyDrive) Whether to restrict the results to changes inside the My Drive hierarchy.
Drive.Changes.Watch	setSpaces(String spaces) A comma-separated list of spaces to query within the corpora.
Drive.Changes.Watch	setSupportsAllDrives(Boolean supportsAllDrives) Whether the requesting application supports both My Drives and shared drives.
Drive.Changes.Watch	setSupportsTeamDrives(Boolean supportsTeamDrives) Deprecated: Use `supportsAllDrives` instead.
Drive.Changes.Watch	setTeamDriveId(String teamDriveId) Deprecated: Use `driveId` instead.
Drive.Changes.Watch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Drive.Changes.Watch	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, 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

Watch

protected Watch(String pageToken,
                Channel content)

Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/drive/api/guides/push). 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:

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.

content - the Channel

Since:

1.13

Method Detail

set$Xgafv

public Drive.Changes.Watch set$Xgafv(String $Xgafv)

Description copied from class: DriveRequest

V1 error format.

Overrides:

set$Xgafv in class DriveRequest<Channel>

setAccessToken

public Drive.Changes.Watch setAccessToken(String accessToken)

Description copied from class: DriveRequest

OAuth access token.

Overrides:

setAccessToken in class DriveRequest<Channel>

setAlt

public Drive.Changes.Watch setAlt(String alt)

Description copied from class: DriveRequest

Data format for response.

Overrides:

setAlt in class DriveRequest<Channel>

setCallback

public Drive.Changes.Watch setCallback(String callback)

Description copied from class: DriveRequest

JSONP

Overrides:

setCallback in class DriveRequest<Channel>

setFields

public Drive.Changes.Watch setFields(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(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(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(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(String quotaUser)

Description copied from class: DriveRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DriveRequest<Channel>

setUploadType

public Drive.Changes.Watch setUploadType(String uploadType)

Description copied from class: DriveRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DriveRequest<Channel>

setUploadProtocol

public Drive.Changes.Watch setUploadProtocol(String uploadProtocol)

Description copied from class: DriveRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DriveRequest<Channel>

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.Watch 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.

getDriveId

public String getDriveId()

The shared drive from which changes will be 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.Watch setDriveId(String driveId)

The shared drive from which changes will be 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.Watch 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.

getIncludeItemsFromAllDrives

public Boolean getIncludeItemsFromAllDrives()

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

setIncludeItemsFromAllDrives

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

getIncludeLabels

public String getIncludeLabels()

A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.

setIncludeLabels

public Drive.Changes.Watch setIncludeLabels(String includeLabels)

A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.

getIncludePermissionsForView

public String getIncludePermissionsForView()

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

setIncludePermissionsForView

public Drive.Changes.Watch setIncludePermissionsForView(String includePermissionsForView)

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

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.Watch 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()

Deprecated: Use `includeItemsFromAllDrives` instead. [default: false]

setIncludeTeamDriveItems

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

getPageSize

public Integer getPageSize()

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

setPageSize

public Drive.Changes.Watch 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.Watch 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 corpora. Supported values are 'drive' and 'appDataFolder'. [default: drive]

setSpaces

public Drive.Changes.Watch setSpaces(String spaces)

A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.

getSupportsAllDrives

public Boolean getSupportsAllDrives()

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

setSupportsAllDrives

public Drive.Changes.Watch 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.Watch 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.Watch setTeamDriveId(String teamDriveId)

Deprecated: Use `driveId` instead.

set

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

Overrides:

set in class DriveRequest<Channel>