• Home
• com.google.apis
• google-api-services-drive
• v2-rev20240521-2.0.0
• source code
• Drive.Files.Watch.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.drive.Drive.Files.Watch.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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
API_VERSION_HEADER, USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
Watch(String fileId,
     Channel content)
Subscribes to changes to a file.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Boolean
getAcknowledgeAbuse()
Whether the user is acknowledging the risk of downloading known malware or other abusive files.



String
getFileId()
The ID for the file in question.



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.



String
getProjection()
Deprecated: This parameter has no function.



String
getRevisionId()
Specifies the Revision ID that should be downloaded.



Boolean
getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives.



Boolean
getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead.



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
isSupportsAllDrives()
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(String parameterName,
   Object value) 


Drive.Files.Watch
set$Xgafv(String $Xgafv)
V1 error format.



Drive.Files.Watch
setAccessToken(String accessToken)
OAuth access token.



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



Drive.Files.Watch
setCallback(String callback)
JSONP



Drive.Files.Watch
setFields(String fields)
Selector specifying which fields to include in a partial response.



Drive.Files.Watch
setFileId(String fileId)
The ID for the file in question.



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
setProjection(String projection)
Deprecated: This parameter has no function.



Drive.Files.Watch
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



Drive.Files.Watch
setRevisionId(String revisionId)
Specifies the Revision ID that should be downloaded.



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
setUpdateViewedDate(Boolean updateViewedDate)
Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and
 an empty request body.



Drive.Files.Watch
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Drive.Files.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 fileId,
                Channel content)
Subscribes to changes to 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





set$Xgafv
public Drive.Files.Watch set$Xgafv(String $Xgafv)
Description copied from class: DriveRequest
V1 error format.

Overrides:
set$Xgafv in class DriveRequest<Channel>








setAccessToken
public Drive.Files.Watch setAccessToken(String accessToken)
Description copied from class: DriveRequest
OAuth access token.

Overrides:
setAccessToken in class DriveRequest<Channel>








setAlt
public Drive.Files.Watch setAlt(String alt)
Description copied from class: DriveRequest
Data format for response.

Overrides:
setAlt in class DriveRequest<Channel>








setCallback
public Drive.Files.Watch setCallback(String callback)
Description copied from class: DriveRequest
JSONP

Overrides:
setCallback 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
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.Files.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.Files.Watch setUploadProtocol(String uploadProtocol)
Description copied from class: DriveRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class DriveRequest<Channel>








getFileId
public String getFileId()
The ID for the file in question.







setFileId
public Drive.Files.Watch setFileId(String fileId)
The ID for the file in question.







getAcknowledgeAbuse
public 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(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.
 







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.







getProjection
public String getProjection()
Deprecated: This parameter has no function.







setProjection
public Drive.Files.Watch setProjection(String projection)
Deprecated: This parameter has no function.







getRevisionId
public String getRevisionId()
Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.







setRevisionId
public Drive.Files.Watch setRevisionId(String revisionId)
Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.







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.
 







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







setUpdateViewedDate
public Drive.Files.Watch setUpdateViewedDate(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(String parameterName,
                             Object value)

Overrides:
set in class DriveRequest<Channel>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.