PeopleService.People.GetBatchGet (People API v1-rev20251117-2.0.0)

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<GetPeopleResponse>
        
        com.google.api.services.people.v1.PeopleService.People.GetBatchGet

All Implemented Interfaces:: Cloneable, Map<String,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
  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 GetBatchGet()
Provides information about a list of specific people by specifying a list of requested resource names.

Constructors
Modifier	Constructor and Description
`protected`	`GetBatchGet()` Provides information about a list of specific people by specifying a list of requested resource names.

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`	`getPersonFields()` Required.
`String`	`getRequestMaskIncludeField()` Required.
`List<String>`	`getResourceNames()` Required.
`List<String>`	`getSources()` Optional.
`PeopleService.People.GetBatchGet`	`set(String parameterName, Object value)`
`PeopleService.People.GetBatchGet`	`set$Xgafv(String $Xgafv)` V1 error format.
`PeopleService.People.GetBatchGet`	`setAccessToken(String accessToken)` OAuth access token.
`PeopleService.People.GetBatchGet`	`setAlt(String alt)` Data format for response.
`PeopleService.People.GetBatchGet`	`setCallback(String callback)` JSONP
`PeopleService.People.GetBatchGet`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`PeopleService.People.GetBatchGet`	`setKey(String key)` API key.
`PeopleService.People.GetBatchGet`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`PeopleService.People.GetBatchGet`	`setPersonFields(String personFields)` Required.
`PeopleService.People.GetBatchGet`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`PeopleService.People.GetBatchGet`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`PeopleService.People.GetBatchGet`	`setRequestMaskIncludeField(String requestMaskIncludeField)` Required.
`PeopleService.People.GetBatchGet`	`setResourceNames(List<String> resourceNames)` Required.
`PeopleService.People.GetBatchGet`	`setSources(List<String> sources)` Optional.
`PeopleService.People.GetBatchGet`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`PeopleService.People.GetBatchGet`	`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
  - GetBatchGet
```
protected 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 returns 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 IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetPeopleResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetPeopleResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public PeopleService.People.GetBatchGet set$Xgafv(String $Xgafv)
```
    Description copied from class: PeopleServiceRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PeopleServiceRequest<GetPeopleResponse>
  - setAccessToken
```
public PeopleService.People.GetBatchGet setAccessToken(String accessToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PeopleServiceRequest<GetPeopleResponse>
  - setAlt
```
public PeopleService.People.GetBatchGet setAlt(String alt)
```
    Description copied from class: PeopleServiceRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PeopleServiceRequest<GetPeopleResponse>
  - setCallback
```
public PeopleService.People.GetBatchGet setCallback(String callback)
```
    Description copied from class: PeopleServiceRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PeopleServiceRequest<GetPeopleResponse>
  - setFields
```
public PeopleService.People.GetBatchGet setFields(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(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(String oauthToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PeopleServiceRequest<GetPeopleResponse>
  - setPrettyPrint
```
public PeopleService.People.GetBatchGet setPrettyPrint(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(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(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(String uploadProtocol)
```
    Description copied from class: PeopleServiceRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PeopleServiceRequest<GetPeopleResponse>
  - getPersonFields
```
public 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 * 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.GetBatchGet setPersonFields(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 * 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.GetBatchGet 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`.
  - getResourceNames
```
public List<String> getResourceNames()
```
    Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&resourceNames=&... - 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`. There is a maximum of 200 resource names.
  - setResourceNames
```
public PeopleService.People.GetBatchGet setResourceNames(List<String> resourceNames)
```
    Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&resourceNames=&... - 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`. There is a maximum of 200 resource names.
  - getSources
```
public List<String> getSources()
```
    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
  - setSources
```
public PeopleService.People.GetBatchGet setSources(List<String> sources)
```
    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
  - set
```
public PeopleService.People.GetBatchGet set(String parameterName,
                                            Object value)
```
    Overrides:
    
    set in class PeopleServiceRequest<GetPeopleResponse>

Class PeopleService.People.GetBatchGet

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

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

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GetBatchGet

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getPersonFields

setPersonFields

getRequestMaskIncludeField

setRequestMaskIncludeField

getResourceNames

setResourceNames

getSources

setSources

set