com.google.api.services.drive

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

All Implemented Interfaces:

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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Watch(String fileId, Channel content) Subscribes to changes to a file.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.GenericUrl	buildHttpRequestUrl()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
Boolean	getAcknowledgeAbuse() Whether the user is acknowledging the risk of downloading known malware or other abusive files.
String	getFileId() The ID of the file.
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	getSupportsAllDrives() Whether the requesting application supports both My Drives and shared drives.
Boolean	getSupportsTeamDrives() Deprecated use supportsAllDrives instead.
boolean	isAcknowledgeAbuse() 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.Files.Watch	set(String parameterName, Object value)
Drive.Files.Watch	setAcknowledgeAbuse(Boolean acknowledgeAbuse) Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Drive.Files.Watch	setAlt(String alt) Data format for the response.
Drive.Files.Watch	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Watch	setFileId(String fileId) The ID of the file.
Drive.Files.Watch	setIncludeLabels(String includeLabels) A comma-separated list of IDs of labels to include in the labelInfo part of the response.
Drive.Files.Watch	setIncludePermissionsForView(String includePermissionsForView) Specifies which additional view's permissions to include in the response.
Drive.Files.Watch	setKey(String key) API key.
Drive.Files.Watch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Watch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Watch	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Drive.Files.Watch	setSupportsAllDrives(Boolean supportsAllDrives) Whether the requesting application supports both My Drives and shared drives.
Drive.Files.Watch	setSupportsTeamDrives(Boolean supportsTeamDrives) Deprecated use supportsAllDrives instead.
Drive.Files.Watch	setUserIp(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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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 fileId,
                Channel content)

Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification. 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 of the file.

content - the Channel

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:

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

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

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

Throws:

IOException

executeMedia

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

Overrides:

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

Throws:

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(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<Channel>

setFields

public Drive.Files.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.Files.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.Files.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.Files.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.Files.Watch setQuotaUser(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.Files.Watch setUserIp(String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<Channel>

getFileId

public String getFileId()

The ID of the file.

setFileId

public Drive.Files.Watch setFileId(String fileId)

The ID of the file.

getAcknowledgeAbuse

public Boolean getAcknowledgeAbuse()

Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. [default: false]

setAcknowledgeAbuse

public Drive.Files.Watch setAcknowledgeAbuse(Boolean acknowledgeAbuse)

Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

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. This is only applicable when alt=media.

getIncludeLabels

public String getIncludeLabels()

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

setIncludeLabels

public Drive.Files.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.Files.Watch setIncludePermissionsForView(String includePermissionsForView)

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

getSupportsAllDrives

public Boolean getSupportsAllDrives()

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

setSupportsAllDrives

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

set

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

Overrides:

set in class DriveRequest<Channel>