target.apidocs.com.google.api.services.gmail.Gmail.Users.Stop.html Maven / Gradle / Ivy
<span class="http"><span class="http"><span class="scala"><span class="hljs-type">Gmail</span>.<span class="hljs-type">Users</span>.<span class="hljs-type">Stop</span> (<span class="hljs-type">Gmail</span> <span class="hljs-type">API</span> v1-rev20230925<span class="hljs-number">-2.0</span><span class="hljs-number">.0</span>)</span></span></span>
com.google.api.services.gmail
Class Gmail.Users.Stop
- 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<Void>
-
- com.google.api.services.gmail.Gmail.Users.Stop
-
-
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>
-
Field Summary
-
Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX
-
Constructor Summary
Constructors Modifier Constructor and Description protected
Stop(String userId)
Stop receiving push notifications for the given user mailbox.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description String
getUserId()
The user's email address.
Gmail.Users.Stop
set(String parameterName,
Object value)
Gmail.Users.Stop
set$Xgafv(String $Xgafv)
V1 error format.
Gmail.Users.Stop
setAccessToken(String accessToken)
OAuth access token.
Gmail.Users.Stop
setAlt(String alt)
Data format for response.
Gmail.Users.Stop
setCallback(String callback)
JSONP
Gmail.Users.Stop
setFields(String fields)
Selector specifying which fields to include in a partial response.
Gmail.Users.Stop
setKey(String key)
API key.
Gmail.Users.Stop
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Gmail.Users.Stop
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Gmail.Users.Stop
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Gmail.Users.Stop
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Gmail.Users.Stop
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Gmail.Users.Stop
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
-
Stop
protected Stop(String userId)
Stop receiving push notifications for the given user mailbox.
Create a request for the method "users.stop".
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]
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Gmail.Users.Stop set$Xgafv(String $Xgafv)
Description copied from class: GmailRequest
V1 error format.
- Overrides:
set$Xgafv
in class GmailRequest<Void>
-
setAccessToken
public Gmail.Users.Stop setAccessToken(String accessToken)
Description copied from class: GmailRequest
OAuth access token.
- Overrides:
setAccessToken
in class GmailRequest<Void>
-
setAlt
public Gmail.Users.Stop setAlt(String alt)
Description copied from class: GmailRequest
Data format for response.
- Overrides:
setAlt
in class GmailRequest<Void>
-
setCallback
public Gmail.Users.Stop setCallback(String callback)
Description copied from class: GmailRequest
JSONP
- Overrides:
setCallback
in class GmailRequest<Void>
-
setFields
public Gmail.Users.Stop setFields(String fields)
Description copied from class: GmailRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class GmailRequest<Void>
-
setKey
public Gmail.Users.Stop 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<Void>
-
setOauthToken
public Gmail.Users.Stop setOauthToken(String oauthToken)
Description copied from class: GmailRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class GmailRequest<Void>
-
setPrettyPrint
public Gmail.Users.Stop setPrettyPrint(Boolean prettyPrint)
Description copied from class: GmailRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class GmailRequest<Void>
-
setQuotaUser
public Gmail.Users.Stop 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<Void>
-
setUploadType
public Gmail.Users.Stop setUploadType(String uploadType)
Description copied from class: GmailRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class GmailRequest<Void>
-
setUploadProtocol
public Gmail.Users.Stop setUploadProtocol(String uploadProtocol)
Description copied from class: GmailRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class GmailRequest<Void>
-
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.Stop setUserId(String userId)
The user's email address. The special value `me` can be used to indicate the authenticated
user.
-
set
public Gmail.Users.Stop set(String parameterName,
Object value)
- Overrides:
set
in class GmailRequest<Void>
Copyright © 2011–2023 Google. All rights reserved.