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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetProfile(String userId) Gets the current user's Gmail profile.

Method Summary

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	setAlt(String alt) Data format for the response.
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) An opaque string that represents a user for quota purposes.
Gmail.Users.GetProfile	setUserId(String userId) The user's email address.
Gmail.Users.GetProfile	setUserIp(String userIp) Deprecated.

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

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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

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

setAlt

public Gmail.Users.GetProfile setAlt(String alt)

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt 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

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class GmailRequest<Profile>

setUserIp

public Gmail.Users.GetProfile setUserIp(String userIp)

Description copied from class: GmailRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp 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>