target.apidocs.com.google.api.services.drive.Drive.Files.Watch.html Maven / Gradle / Ivy
Drive.Files.Watch (Drive API v2-rev20180830-1.26.0)
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
-
- 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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Watch(String fileId,
Channel content)
Subscribe to changes on a file
Create a request for the method "files.watch".
-
Method Summary
All Methods Instance Methods Concrete Methods
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 for the file in question.
String
getProjection()
This parameter is deprecated and has no function.
String
getRevisionId()
Specifies the Revision ID that should be downloaded.
Boolean
getSupportsTeamDrives()
Whether the requesting application supports Team Drives.
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(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 for the file in question.
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)
This parameter is deprecated and has no function.
Drive.Files.Watch
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Drive.Files.Watch
setRevisionId(String revisionId)
Specifies the Revision ID that should be downloaded.
Drive.Files.Watch
setSupportsTeamDrives(Boolean supportsTeamDrives)
Whether the requesting application supports Team Drives.
Drive.Files.Watch
setUpdateViewedDate(Boolean updateViewedDate)
Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and
an empty request body.
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, 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
-
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)
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(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 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.
-
getProjection
public String getProjection()
This parameter is deprecated and has no function.
-
setProjection
public Drive.Files.Watch setProjection(String projection)
This parameter is deprecated and 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.
-
getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Whether the requesting application supports Team Drives. [default: false]
-
setSupportsTeamDrives
public Drive.Files.Watch setSupportsTeamDrives(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 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>
Copyright © 2011–2018 Google. All rights reserved.