Google OAuth2 API v2 (revision 32)

com.google.api.services.oauth2
Class Oauth2.Userinfo.Get

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.oauth2.Oauth2Request<Userinfo>
                      com.google.api.services.oauth2.Oauth2.Userinfo.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Oauth2.Userinfo

public class Oauth2.Userinfo.Get
extends Oauth2Request<Userinfo>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

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>

Constructor Summary

protected

Oauth2.Userinfo.Get() Create a request for the method "userinfo.get".

Method Summary

HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Oauth2.Userinfo.Get	set(String parameterName, Object value)
Oauth2.Userinfo.Get	setAlt(String alt) Data format for the response.
Oauth2.Userinfo.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Oauth2.Userinfo.Get	setKey(String key) API key.
Oauth2.Userinfo.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Oauth2.Userinfo.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Oauth2.Userinfo.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Oauth2.Userinfo.Get	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.oauth2.Oauth2Request

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

Constructor Detail

Oauth2.Userinfo.Get

protected Oauth2.Userinfo.Get()

Create a request for the method "userinfo.get". This request holds the parameters needed by the the oauth2 server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Userinfo>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Userinfo>

Throws:

IOException

setAlt

public Oauth2.Userinfo.Get setAlt(String alt)

Description copied from class: Oauth2Request

Data format for the response.

Overrides:

setAlt in class Oauth2Request<Userinfo>

setFields

public Oauth2.Userinfo.Get setFields(String fields)

Description copied from class: Oauth2Request

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class Oauth2Request<Userinfo>

setKey

public Oauth2.Userinfo.Get setKey(String key)

Description copied from class: Oauth2Request

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 Oauth2Request<Userinfo>

setOauthToken

public Oauth2.Userinfo.Get setOauthToken(String oauthToken)

Description copied from class: Oauth2Request

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class Oauth2Request<Userinfo>

setPrettyPrint

public Oauth2.Userinfo.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: Oauth2Request

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class Oauth2Request<Userinfo>

setQuotaUser

public Oauth2.Userinfo.Get setQuotaUser(String quotaUser)

Description copied from class: Oauth2Request

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 userIp if both are provided.

Overrides:

setQuotaUser in class Oauth2Request<Userinfo>

setUserIp

public Oauth2.Userinfo.Get setUserIp(String userIp)

Description copied from class: Oauth2Request

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class Oauth2Request<Userinfo>

set

public Oauth2.Userinfo.Get set(String parameterName,
                               Object value)

Overrides:

set in class Oauth2Request<Userinfo>