com.google.api.services.drive

Class Drive.Files.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.Files.Watch

All Implemented Interfaces:

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

Enclosing class:

Drive.Files

public class Drive.Files.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.Files.Watch(java.lang.String fileId, Channel content) Subscribe to changes on a file Create a request for the method "files.watch".

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.GenericUrl	buildHttpRequestUrl()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(java.io.OutputStream outputStream)
java.io.InputStream	executeMediaAsInputStream()
java.lang.Boolean	getAcknowledgeAbuse() Whether the user is acknowledging the risk of downloading known malware or other abusive files.
java.lang.String	getFileId() The ID for the file in question.
java.lang.String	getProjection() This parameter is deprecated and has no function.
java.lang.String	getRevisionId() Specifies the Revision ID that should be downloaded.
java.lang.Boolean	getSupportsTeamDrives() Whether the requesting application supports Team Drives.
java.lang.Boolean	getUpdateViewedDate() Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
boolean	isAcknowledgeAbuse() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsTeamDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isUpdateViewedDate() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Files.Watch	set(java.lang.String parameterName, java.lang.Object value)
Drive.Files.Watch	setAcknowledgeAbuse(java.lang.Boolean acknowledgeAbuse) Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Drive.Files.Watch	setAlt(java.lang.String alt) Data format for the response.
Drive.Files.Watch	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Watch	setFileId(java.lang.String fileId) The ID for the file in question.
Drive.Files.Watch	setKey(java.lang.String key) API key.
Drive.Files.Watch	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Watch	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Watch	setProjection(java.lang.String projection) This parameter is deprecated and has no function.
Drive.Files.Watch	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Files.Watch	setRevisionId(java.lang.String revisionId) Specifies the Revision ID that should be downloaded.
Drive.Files.Watch	setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives) Whether the requesting application supports Team Drives.
Drive.Files.Watch	setUpdateViewedDate(java.lang.Boolean updateViewedDate) Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
Drive.Files.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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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.Files.Watch

protected Drive.Files.Watch(java.lang.String fileId,
                 Channel content)

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

fileId - The ID for the file in question.

content - the Channel

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(java.io.OutputStream outputStream)
                               throws java.io.IOException

Overrides:

executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Channel>

Throws:

java.io.IOException

executeMediaAsInputStream

public java.io.InputStream executeMediaAsInputStream()
                                              throws java.io.IOException

Overrides:

executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Channel>

Throws:

java.io.IOException

executeMedia

public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws java.io.IOException

Overrides:

executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Channel>

Throws:

java.io.IOException

buildHttpRequestUrl

public com.google.api.client.http.GenericUrl buildHttpRequestUrl()

Overrides:

buildHttpRequestUrl in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Channel>

setAlt

public Drive.Files.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.Files.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.Files.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.Files.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.Files.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.Files.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.Files.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>

getFileId

public java.lang.String getFileId()

The ID for the file in question.

setFileId

public Drive.Files.Watch setFileId(java.lang.String fileId)

The ID for the file in question.

getAcknowledgeAbuse

public java.lang.Boolean getAcknowledgeAbuse()

Whether the user is acknowledging the risk of downloading known malware or other abusive files. [default: false]

setAcknowledgeAbuse

public Drive.Files.Watch setAcknowledgeAbuse(java.lang.Boolean acknowledgeAbuse)

Whether the user is acknowledging the risk of downloading known malware or other abusive files.

isAcknowledgeAbuse

public boolean isAcknowledgeAbuse()

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 user is acknowledging the risk of downloading known malware or other abusive files.

getProjection

public java.lang.String getProjection()

This parameter is deprecated and has no function.

setProjection

public Drive.Files.Watch setProjection(java.lang.String projection)

This parameter is deprecated and has no function.

getRevisionId

public java.lang.String getRevisionId()

Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

setRevisionId

public Drive.Files.Watch setRevisionId(java.lang.String revisionId)

Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

getSupportsTeamDrives

public java.lang.Boolean getSupportsTeamDrives()

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

setSupportsTeamDrives

public Drive.Files.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.

getUpdateViewedDate

public java.lang.Boolean getUpdateViewedDate()

Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. [default: false]

setUpdateViewedDate

public Drive.Files.Watch setUpdateViewedDate(java.lang.Boolean updateViewedDate)

Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

isUpdateViewedDate

public boolean isUpdateViewedDate()

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 files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

set

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

Overrides:

set in class DriveRequest<Channel>