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	Drive.Changes.Watch(java.lang.String pageToken, Channel content) Subscribes to changes for a user.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getIncludeRemoved() Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost access.
java.lang.Integer	getPageSize() The maximum number of changes to return per page.
java.lang.String	getPageToken() The token for continuing a previous list request on the next page.
java.lang.Boolean	getRestrictToMyDrive() Whether to restrict the results to changes inside the My Drive hierarchy.
java.lang.String	getSpaces() A comma-separated list of spaces to query within the user corpus.
boolean	isIncludeRemoved() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isRestrictToMyDrive() 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	setIncludeRemoved(java.lang.Boolean includeRemoved) Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost access.
Drive.Changes.Watch	setKey(java.lang.String key) API key.
Drive.Changes.Watch	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Changes.Watch	setPageSize(java.lang.Integer pageSize) The maximum number of changes to return per page.
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) Available to use for quota purposes for server-side applications.
Drive.Changes.Watch	setRestrictToMyDrive(java.lang.Boolean restrictToMyDrive) Whether to restrict the results to changes inside the My Drive hierarchy.
Drive.Changes.Watch	setSpaces(java.lang.String spaces) A comma-separated list of spaces to query within the user corpus.
Drive.Changes.Watch	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

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

Constructor Detail

Drive.Changes.Watch

protected Drive.Changes.Watch(java.lang.String pageToken,
                   Channel content)

Subscribes 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:

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

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

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 userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<Channel>

setUserIp

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

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<Channel>

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 within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. [default: drive]

setSpaces

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

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

getPageSize

public java.lang.Integer getPageSize()

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

setPageSize

public Drive.Changes.Watch setPageSize(java.lang.Integer pageSize)

The maximum number of changes to return per page.

getIncludeRemoved

public java.lang.Boolean getIncludeRemoved()

Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost access. [default: true]

setIncludeRemoved

public Drive.Changes.Watch setIncludeRemoved(java.lang.Boolean includeRemoved)

Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost 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 left the view of the changes list, for example by deletion or lost access.

getRestrictToMyDrive

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

set

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

Overrides:

set in class DriveRequest<Channel>