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

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>

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getIncludeDeleted() Whether to include deleted items.
Boolean	getIncludeSubscribed() Whether to include public files the user has opened and shared files.
Integer	getMaxResults() Maximum number of changes to return.
String	getPageToken() Page token for changes.
Long	getStartChangeId() Change ID to start listing changes from.
boolean	isIncludeDeleted() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isIncludeSubscribed() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Changes.Watch	set(String parameterName, Object value)
Drive.Changes.Watch	setAlt(String alt) Data format for the response.
Drive.Changes.Watch	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Changes.Watch	setIncludeDeleted(Boolean includeDeleted) Whether to include deleted items.
Drive.Changes.Watch	setIncludeSubscribed(Boolean includeSubscribed) Whether to include public files the user has opened and shared files.
Drive.Changes.Watch	setKey(String key) API key.
Drive.Changes.Watch	setMaxResults(Integer maxResults) Maximum number of changes to return.
Drive.Changes.Watch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Changes.Watch	setPageToken(String pageToken) Page token for changes.
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	setStartChangeId(Long startChangeId) Change ID to start listing changes from.
Drive.Changes.Watch	setUserIp(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(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(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

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

Overrides:

setQuotaUser in class DriveRequest<Channel>

setUserIp

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

getIncludeSubscribed

public Boolean getIncludeSubscribed()

Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own. [default: true]

setIncludeSubscribed

public Drive.Changes.Watch setIncludeSubscribed(Boolean includeSubscribed)

Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.

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 public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.

getStartChangeId

public Long getStartChangeId()

Change ID to start listing changes from.

setStartChangeId

public Drive.Changes.Watch setStartChangeId(Long startChangeId)

Change ID to start listing changes from.

getIncludeDeleted

public Boolean getIncludeDeleted()

Whether to include deleted items. [default: true]

setIncludeDeleted

public Drive.Changes.Watch setIncludeDeleted(Boolean includeDeleted)

Whether to include deleted items.

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 deleted items.

getMaxResults

public Integer getMaxResults()

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

setMaxResults

public Drive.Changes.Watch setMaxResults(Integer maxResults)

Maximum number of changes to return.

getPageToken

public String getPageToken()

Page token for changes.

setPageToken

public Drive.Changes.Watch setPageToken(String pageToken)

Page token for changes.

set

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

Overrides:

set in class DriveRequest<Channel>