com.google.api.services.people.v1

Class PeopleService.People.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.people.v1.PeopleServiceRequest<Person>

com.google.api.services.people.v1.PeopleService.People.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

PeopleService.People

public class PeopleService.People.Get
extends PeopleServiceRequest<Person>

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	Get(String resourceName) Provides information about a person by specifying a resource name.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getPersonFields() Required.
String	getRequestMaskIncludeField() Required.
String	getResourceName() Required.
List<String>	getSources() Optional.
PeopleService.People.Get	set(String parameterName, Object value)
PeopleService.People.Get	set$Xgafv(String $Xgafv) V1 error format.
PeopleService.People.Get	setAccessToken(String accessToken) OAuth access token.
PeopleService.People.Get	setAlt(String alt) Data format for response.
PeopleService.People.Get	setCallback(String callback) JSONP
PeopleService.People.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
PeopleService.People.Get	setKey(String key) API key.
PeopleService.People.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
PeopleService.People.Get	setPersonFields(String personFields) Required.
PeopleService.People.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
PeopleService.People.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
PeopleService.People.Get	setRequestMaskIncludeField(String requestMaskIncludeField) Required.
PeopleService.People.Get	setResourceName(String resourceName) Required.
PeopleService.People.Get	setSources(List<String> sources) Optional.
PeopleService.People.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
PeopleService.People.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.people.v1.PeopleServiceRequest

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

Get

protected Get(String resourceName)

Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified. Create a request for the method "people.get". This request holds the parameters needed by the the people server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

resourceName - Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.

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

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Person>

Throws:

IOException

set$Xgafv

public PeopleService.People.Get set$Xgafv(String $Xgafv)

Description copied from class: PeopleServiceRequest

V1 error format.

Overrides:

set$Xgafv in class PeopleServiceRequest<Person>

setAccessToken

public PeopleService.People.Get setAccessToken(String accessToken)

Description copied from class: PeopleServiceRequest

OAuth access token.

Overrides:

setAccessToken in class PeopleServiceRequest<Person>

setAlt

public PeopleService.People.Get setAlt(String alt)

Description copied from class: PeopleServiceRequest

Data format for response.

Overrides:

setAlt in class PeopleServiceRequest<Person>

setCallback

public PeopleService.People.Get setCallback(String callback)

Description copied from class: PeopleServiceRequest

JSONP

Overrides:

setCallback in class PeopleServiceRequest<Person>

setFields

public PeopleService.People.Get setFields(String fields)

Description copied from class: PeopleServiceRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PeopleServiceRequest<Person>

setKey

public PeopleService.People.Get setKey(String key)

Description copied from class: PeopleServiceRequest

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 PeopleServiceRequest<Person>

setOauthToken

public PeopleService.People.Get setOauthToken(String oauthToken)

Description copied from class: PeopleServiceRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PeopleServiceRequest<Person>

setPrettyPrint

public PeopleService.People.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: PeopleServiceRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PeopleServiceRequest<Person>

setQuotaUser

public PeopleService.People.Get setQuotaUser(String quotaUser)

Description copied from class: PeopleServiceRequest

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 PeopleServiceRequest<Person>

setUploadType

public PeopleService.People.Get setUploadType(String uploadType)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadType in class PeopleServiceRequest<Person>

setUploadProtocol

public PeopleService.People.Get setUploadProtocol(String uploadProtocol)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadProtocol in class PeopleServiceRequest<Person>

getResourceName

public String getResourceName()

Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.

setResourceName

public PeopleService.People.Get setResourceName(String resourceName)

Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.

getPersonFields

public String getPersonFields()

Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses skills * urls * userDefined

setPersonFields

public PeopleService.People.Get setPersonFields(String personFields)

Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

getRequestMaskIncludeField

public String getRequestMaskIncludeField()

Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

setRequestMaskIncludeField

public PeopleService.People.Get setRequestMaskIncludeField(String requestMaskIncludeField)

Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

getSources

public List<String> getSources()

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.

setSources

public PeopleService.People.Get setSources(List<String> sources)

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.

set

public PeopleService.People.Get set(String parameterName,
                                    Object value)

Overrides:

set in class PeopleServiceRequest<Person>