com.google.api.services.people.v1

Class PeopleService.People.GetBatchGet

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<GetPeopleResponse>

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

PeopleService.People

public class PeopleService.People.GetBatchGet
extends PeopleServiceRequest<GetPeopleResponse>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.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	PeopleService.People.GetBatchGet() Provides information about a list of specific people by specifying a list of requested resource names.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getPersonFields() Required.** A field mask to restrict which fields on each person are returned.
java.lang.String	getRequestMaskIncludeField() Required.** Comma-separated list of person fields to be included in the response.
java.util.List<java.lang.String>	getResourceNames() The resource names of the people to provide information about.
PeopleService.People.GetBatchGet	set(java.lang.String parameterName, java.lang.Object value)
PeopleService.People.GetBatchGet	set$Xgafv(java.lang.String $Xgafv) V1 error format.
PeopleService.People.GetBatchGet	setAccessToken(java.lang.String accessToken) OAuth access token.
PeopleService.People.GetBatchGet	setAlt(java.lang.String alt) Data format for response.
PeopleService.People.GetBatchGet	setBearerToken(java.lang.String bearerToken) OAuth bearer token.
PeopleService.People.GetBatchGet	setCallback(java.lang.String callback) JSONP
PeopleService.People.GetBatchGet	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
PeopleService.People.GetBatchGet	setKey(java.lang.String key) API key.
PeopleService.People.GetBatchGet	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
PeopleService.People.GetBatchGet	setPersonFields(java.lang.String personFields) **Required.** A field mask to restrict which fields on each person are returned.
PeopleService.People.GetBatchGet	setPp(java.lang.Boolean pp) Pretty-print response.
PeopleService.People.GetBatchGet	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
PeopleService.People.GetBatchGet	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
PeopleService.People.GetBatchGet	setRequestMaskIncludeField(java.lang.String requestMaskIncludeField) **Required.** Comma-separated list of person fields to be included in the response.
PeopleService.People.GetBatchGet	setResourceNames(java.util.List<java.lang.String> resourceNames) The resource names of the people to provide information about.
PeopleService.People.GetBatchGet	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
PeopleService.People.GetBatchGet	setUploadType(java.lang.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, getBearerToken, getCallback, getFields, getKey, getOauthToken, getPp, 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, 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

PeopleService.People.GetBatchGet

protected PeopleService.People.GetBatchGet()

Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified. Create a request for the method "people.getBatchGet". 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.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetPeopleResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

java.io.IOException

set$Xgafv

public PeopleService.People.GetBatchGet set$Xgafv(java.lang.String $Xgafv)

Description copied from class: PeopleServiceRequest

V1 error format.

Overrides:

set$Xgafv in class PeopleServiceRequest<GetPeopleResponse>

setAccessToken

public PeopleService.People.GetBatchGet setAccessToken(java.lang.String accessToken)

Description copied from class: PeopleServiceRequest

OAuth access token.

Overrides:

setAccessToken in class PeopleServiceRequest<GetPeopleResponse>

setAlt

public PeopleService.People.GetBatchGet setAlt(java.lang.String alt)

Description copied from class: PeopleServiceRequest

Data format for response.

Overrides:

setAlt in class PeopleServiceRequest<GetPeopleResponse>

setBearerToken

public PeopleService.People.GetBatchGet setBearerToken(java.lang.String bearerToken)

Description copied from class: PeopleServiceRequest

OAuth bearer token.

Overrides:

setBearerToken in class PeopleServiceRequest<GetPeopleResponse>

setCallback

public PeopleService.People.GetBatchGet setCallback(java.lang.String callback)

Description copied from class: PeopleServiceRequest

JSONP

Overrides:

setCallback in class PeopleServiceRequest<GetPeopleResponse>

setFields

public PeopleService.People.GetBatchGet setFields(java.lang.String fields)

Description copied from class: PeopleServiceRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PeopleServiceRequest<GetPeopleResponse>

setKey

public PeopleService.People.GetBatchGet setKey(java.lang.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<GetPeopleResponse>

setOauthToken

public PeopleService.People.GetBatchGet setOauthToken(java.lang.String oauthToken)

Description copied from class: PeopleServiceRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PeopleServiceRequest<GetPeopleResponse>

setPp

public PeopleService.People.GetBatchGet setPp(java.lang.Boolean pp)

Description copied from class: PeopleServiceRequest

Pretty-print response.

Overrides:

setPp in class PeopleServiceRequest<GetPeopleResponse>

setPrettyPrint

public PeopleService.People.GetBatchGet setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: PeopleServiceRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PeopleServiceRequest<GetPeopleResponse>

setQuotaUser

public PeopleService.People.GetBatchGet setQuotaUser(java.lang.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<GetPeopleResponse>

setUploadType

public PeopleService.People.GetBatchGet setUploadType(java.lang.String uploadType)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadType in class PeopleServiceRequest<GetPeopleResponse>

setUploadProtocol

public PeopleService.People.GetBatchGet setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadProtocol in class PeopleServiceRequest<GetPeopleResponse>

getPersonFields

public java.lang.String getPersonFields()

Required.** A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * skills * taglines * urls

setPersonFields

public PeopleService.People.GetBatchGet setPersonFields(java.lang.String personFields)

**Required.** A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * skills * taglines * urls

getRequestMaskIncludeField

public java.lang.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.GetBatchGet setRequestMaskIncludeField(java.lang.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`.

getResourceNames

public java.util.List<java.lang.String> getResourceNames()

The resource names of the people 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`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request.

setResourceNames

public PeopleService.People.GetBatchGet setResourceNames(java.util.List<java.lang.String> resourceNames)

The resource names of the people 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`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request.

set

public PeopleService.People.GetBatchGet set(java.lang.String parameterName,
                                   java.lang.Object value)

Overrides:

set in class PeopleServiceRequest<GetPeopleResponse>