com.google.api.services.gmail

Class Gmail.Users.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.gmail.GmailRequest<WatchResponse>

com.google.api.services.gmail.Gmail.Users.Watch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users

public class Gmail.Users.Watch
extends GmailRequest<WatchResponse>

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 userId, WatchRequest content) Set up or update a push notification watch on the given user mailbox.

Method Summary

Modifier and Type	Method and Description
String	getUserId() The user's email address.
Gmail.Users.Watch	set(String parameterName, Object value)
Gmail.Users.Watch	set$Xgafv(String $Xgafv) V1 error format.
Gmail.Users.Watch	setAccessToken(String accessToken) OAuth access token.
Gmail.Users.Watch	setAlt(String alt) Data format for response.
Gmail.Users.Watch	setCallback(String callback) JSONP
Gmail.Users.Watch	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Watch	setKey(String key) API key.
Gmail.Users.Watch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Watch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Watch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Watch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Gmail.Users.Watch	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Gmail.Users.Watch	setUserId(String userId) The user's email address.

Methods inherited from class com.google.api.services.gmail.GmailRequest

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 userId,
                WatchRequest content)

Set up or update a push notification watch on the given user mailbox. Create a request for the method "users.watch". This request holds the parameters needed by the the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Gmail.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

userId - The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

content - the WatchRequest

Since:

1.13

Method Detail

set$Xgafv

public Gmail.Users.Watch set$Xgafv(String $Xgafv)

Description copied from class: GmailRequest

V1 error format.

Overrides:

set$Xgafv in class GmailRequest<WatchResponse>

setAccessToken

public Gmail.Users.Watch setAccessToken(String accessToken)

Description copied from class: GmailRequest

OAuth access token.

Overrides:

setAccessToken in class GmailRequest<WatchResponse>

setAlt

public Gmail.Users.Watch setAlt(String alt)

Description copied from class: GmailRequest

Data format for response.

Overrides:

setAlt in class GmailRequest<WatchResponse>

setCallback

public Gmail.Users.Watch setCallback(String callback)

Description copied from class: GmailRequest

JSONP

Overrides:

setCallback in class GmailRequest<WatchResponse>

setFields

public Gmail.Users.Watch setFields(String fields)

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<WatchResponse>

setKey

public Gmail.Users.Watch setKey(String key)

Description copied from class: GmailRequest

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 GmailRequest<WatchResponse>

setOauthToken

public Gmail.Users.Watch setOauthToken(String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<WatchResponse>

setPrettyPrint

public Gmail.Users.Watch setPrettyPrint(Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<WatchResponse>

setQuotaUser

public Gmail.Users.Watch setQuotaUser(String quotaUser)

Description copied from class: GmailRequest

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 GmailRequest<WatchResponse>

setUploadType

public Gmail.Users.Watch setUploadType(String uploadType)

Description copied from class: GmailRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class GmailRequest<WatchResponse>

setUploadProtocol

public Gmail.Users.Watch setUploadProtocol(String uploadProtocol)

Description copied from class: GmailRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class GmailRequest<WatchResponse>

getUserId

public String getUserId()

The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

setUserId

public Gmail.Users.Watch setUserId(String userId)

The user's email address. The special value `me` can be used to indicate the authenticated user.

set

public Gmail.Users.Watch set(String parameterName,
                             Object value)

Overrides:

set in class GmailRequest<WatchResponse>