target.apidocs.com.google.api.services.drive.Drive.Changes.Watch.html Maven / Gradle / Ivy
Drive.Changes.Watch (Drive API v2-rev20180830-1.26.0)
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
-
- 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
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(Channel content)
Subscribe to changes for a user.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Boolean
getIncludeCorpusRemovals()
Whether changes should include the file resource if the file is still accessible by the user at the
time of the request, even when a file was removed from the list of changes and there will be no
further change entries for this file.
Boolean
getIncludeDeleted()
Whether to include changes indicating that items have been removed from the list of changes, for
example by deletion or loss of access.
Boolean
getIncludeSubscribed()
Whether to include changes outside the My Drive hierarchy in the result.
Boolean
getIncludeTeamDriveItems()
Whether Team Drive files or changes should be included in results.
Integer
getMaxResults()
Maximum number of changes to return.
String
getPageToken()
The token for continuing a previous list request on the next page.
String
getSpaces()
A comma-separated list of spaces to query.
Long
getStartChangeId()
Deprecated - use pageToken instead.
Boolean
getSupportsTeamDrives()
Whether the requesting application supports Team Drives.
String
getTeamDriveId()
The Team Drive from which changes will be returned.
boolean
isIncludeCorpusRemovals()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isIncludeDeleted()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isIncludeSubscribed()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isIncludeTeamDriveItems()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isSupportsTeamDrives()
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
setIncludeCorpusRemovals(Boolean includeCorpusRemovals)
Whether changes should include the file resource if the file is still accessible by the
user at the time of the request, even when a file was removed from the list of changes and
there will be no further change entries for this file.
Drive.Changes.Watch
setIncludeDeleted(Boolean includeDeleted)
Whether to include changes indicating that items have been removed from the list of
changes, for example by deletion or loss of access.
Drive.Changes.Watch
setIncludeSubscribed(Boolean includeSubscribed)
Whether to include changes outside the My Drive hierarchy in the result.
Drive.Changes.Watch
setIncludeTeamDriveItems(Boolean includeTeamDriveItems)
Whether Team Drive files or changes should be included in results.
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)
The token for continuing a previous list request on the next page.
Drive.Changes.Watch
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Drive.Changes.Watch
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Drive.Changes.Watch
setSpaces(String spaces)
A comma-separated list of spaces to query.
Drive.Changes.Watch
setStartChangeId(Long startChangeId)
Deprecated - use pageToken instead.
Drive.Changes.Watch
setSupportsTeamDrives(Boolean supportsTeamDrives)
Whether the requesting application supports Team Drives.
Drive.Changes.Watch
setTeamDriveId(String teamDriveId)
The Team Drive from which changes will be returned.
Drive.Changes.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, 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
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
Watch
protected 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
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- Overrides:
setQuotaUser
in class DriveRequest<Channel>
-
setUserIp
public Drive.Changes.Watch setUserIp(String userIp)
Description copied from class: DriveRequest
Deprecated. Please use quotaUser instead.
- Overrides:
setUserIp
in class DriveRequest<Channel>
-
getIncludeCorpusRemovals
public Boolean getIncludeCorpusRemovals()
Whether changes should include the file resource if the file is still accessible by the user at the
time of the request, even when a file was removed from the list of changes and there will be no
further change entries for this file. [default: false]
-
setIncludeCorpusRemovals
public Drive.Changes.Watch setIncludeCorpusRemovals(Boolean includeCorpusRemovals)
Whether changes should include the file resource if the file is still accessible by the
user at the time of the request, even when a file was removed from the list of changes and
there will be no further change entries for this file.
-
isIncludeCorpusRemovals
public boolean isIncludeCorpusRemovals()
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 changes should include the file resource if the file is still accessible by the user at the
time of the request, even when a file was removed from the list of changes and there will be no
further change entries for this file.
-
getIncludeDeleted
public Boolean getIncludeDeleted()
Whether to include changes indicating that items have been removed from the list of changes, for
example by deletion or loss of access. [default: true]
-
setIncludeDeleted
public Drive.Changes.Watch setIncludeDeleted(Boolean includeDeleted)
Whether to include changes indicating that items have been removed from the list of
changes, for example by deletion or loss of access.
-
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 changes indicating that items have been removed from the list of changes, for
example by deletion or loss of access.
-
getIncludeSubscribed
public Boolean getIncludeSubscribed()
Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes
to files such as those in the Application Data folder or shared files which have not been added to
My Drive will be omitted from the result. [default: true]
-
setIncludeSubscribed
public Drive.Changes.Watch setIncludeSubscribed(Boolean includeSubscribed)
Whether to include changes outside the My Drive hierarchy in the result. When set to false,
changes to files such as those in the Application Data folder or shared files which have
not been added to My Drive will be omitted from the result.
-
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 changes outside the My Drive hierarchy in the result. When set to false, changes
to files such as those in the Application Data folder or shared files which have not been added to
My Drive will be omitted from the result.
-
getIncludeTeamDriveItems
public Boolean getIncludeTeamDriveItems()
Whether Team Drive files or changes should be included in results. [default: false]
-
setIncludeTeamDriveItems
public Drive.Changes.Watch setIncludeTeamDriveItems(Boolean includeTeamDriveItems)
Whether Team Drive files or changes should be included in results.
-
isIncludeTeamDriveItems
public boolean isIncludeTeamDriveItems()
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 Team Drive files or changes should be included in results.
-
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()
The token for continuing a previous list request on the next page. This should be set to the value
of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
-
setPageToken
public Drive.Changes.Watch setPageToken(String pageToken)
The token for continuing a previous list request on the next page. This should be set to
the value of 'nextPageToken' from the previous response or to the response from the
getStartPageToken method.
-
getSpaces
public String getSpaces()
A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and
'photos'.
-
setSpaces
public Drive.Changes.Watch setSpaces(String spaces)
A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder'
and 'photos'.
-
getStartChangeId
public Long getStartChangeId()
Deprecated - use pageToken instead.
-
setStartChangeId
public Drive.Changes.Watch setStartChangeId(Long startChangeId)
Deprecated - use pageToken instead.
-
getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Whether the requesting application supports Team Drives. [default: false]
-
setSupportsTeamDrives
public Drive.Changes.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.
-
getTeamDriveId
public String getTeamDriveId()
The Team Drive from which changes will be returned. If specified the change IDs will be reflective
of the Team Drive; use the combined Team Drive ID and change ID as an identifier.
-
setTeamDriveId
public Drive.Changes.Watch setTeamDriveId(String teamDriveId)
The Team Drive from which changes will be returned. If specified the change IDs will be
reflective of the Team Drive; use the combined Team Drive ID and change ID as an
identifier.
-
set
public Drive.Changes.Watch set(String parameterName,
Object value)
- Overrides:
set
in class DriveRequest<Channel>
Copyright © 2011–2018 Google. All rights reserved.