target.apidocs.com.google.api.services.gmail.Gmail.Users.GetProfile.html Maven / Gradle / Ivy
Gmail.Users.GetProfile (Gmail API v1-rev20230925-2.0.0)
com.google.api.services.gmail
Class Gmail.Users.GetProfile
- 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<Profile>
-
- com.google.api.services.gmail.Gmail.Users.GetProfile
-
- Enclosing class:
- Gmail.Users
public class Gmail.Users.GetProfile
extends GmailRequest<Profile>
-
-
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
GetProfile(String userId)
Gets the current user's Gmail profile.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getUserId()
The user's email address.
Gmail.Users.GetProfile
set(String parameterName,
Object value)
Gmail.Users.GetProfile
set$Xgafv(String $Xgafv)
V1 error format.
Gmail.Users.GetProfile
setAccessToken(String accessToken)
OAuth access token.
Gmail.Users.GetProfile
setAlt(String alt)
Data format for response.
Gmail.Users.GetProfile
setCallback(String callback)
JSONP
Gmail.Users.GetProfile
setFields(String fields)
Selector specifying which fields to include in a partial response.
Gmail.Users.GetProfile
setKey(String key)
API key.
Gmail.Users.GetProfile
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Gmail.Users.GetProfile
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Gmail.Users.GetProfile
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Gmail.Users.GetProfile
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Gmail.Users.GetProfile
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Gmail.Users.GetProfile
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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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
-
GetProfile
protected GetProfile(String userId)
Gets the current user's Gmail profile.
Create a request for the method "users.getProfile".
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
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Profile>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Profile>
- Throws:
IOException
-
set$Xgafv
public Gmail.Users.GetProfile set$Xgafv(String $Xgafv)
Description copied from class: GmailRequest
V1 error format.
- Overrides:
set$Xgafv
in class GmailRequest<Profile>
-
setAccessToken
public Gmail.Users.GetProfile setAccessToken(String accessToken)
Description copied from class: GmailRequest
OAuth access token.
- Overrides:
setAccessToken
in class GmailRequest<Profile>
-
setAlt
public Gmail.Users.GetProfile setAlt(String alt)
Description copied from class: GmailRequest
Data format for response.
- Overrides:
setAlt
in class GmailRequest<Profile>
-
setCallback
public Gmail.Users.GetProfile setCallback(String callback)
Description copied from class: GmailRequest
JSONP
- Overrides:
setCallback
in class GmailRequest<Profile>
-
setFields
public Gmail.Users.GetProfile setFields(String fields)
Description copied from class: GmailRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class GmailRequest<Profile>
-
setKey
public Gmail.Users.GetProfile 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<Profile>
-
setOauthToken
public Gmail.Users.GetProfile setOauthToken(String oauthToken)
Description copied from class: GmailRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class GmailRequest<Profile>
-
setPrettyPrint
public Gmail.Users.GetProfile setPrettyPrint(Boolean prettyPrint)
Description copied from class: GmailRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class GmailRequest<Profile>
-
setQuotaUser
public Gmail.Users.GetProfile 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<Profile>
-
setUploadType
public Gmail.Users.GetProfile setUploadType(String uploadType)
Description copied from class: GmailRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class GmailRequest<Profile>
-
setUploadProtocol
public Gmail.Users.GetProfile setUploadProtocol(String uploadProtocol)
Description copied from class: GmailRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class GmailRequest<Profile>
-
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.GetProfile setUserId(String userId)
The user's email address. The special value `me` can be used to indicate the authenticated
user.
-
set
public Gmail.Users.GetProfile set(String parameterName,
Object value)
- Overrides:
set
in class GmailRequest<Profile>
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy