PeopleService.People.SearchDirectoryPeople (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<SearchDirectoryPeopleResponse>
        
        com.google.api.services.people.v1.PeopleService.People.SearchDirectoryPeople

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: PeopleService.People

public class PeopleService.People.SearchDirectoryPeople
extends PeopleServiceRequest<SearchDirectoryPeopleResponse>

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`	`SearchDirectoryPeople()` Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.

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()`
`List<String>`	`getMergeSources()` Optional.
`Integer`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`String`	`getQuery()` Required.
`String`	`getReadMask()` Required.
`List<String>`	`getSources()` Required.
`PeopleService.People.SearchDirectoryPeople`	`set(String parameterName, Object value)`
`PeopleService.People.SearchDirectoryPeople`	`set$Xgafv(String $Xgafv)` V1 error format.
`PeopleService.People.SearchDirectoryPeople`	`setAccessToken(String accessToken)` OAuth access token.
`PeopleService.People.SearchDirectoryPeople`	`setAlt(String alt)` Data format for response.
`PeopleService.People.SearchDirectoryPeople`	`setCallback(String callback)` JSONP
`PeopleService.People.SearchDirectoryPeople`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`PeopleService.People.SearchDirectoryPeople`	`setKey(String key)` API key.
`PeopleService.People.SearchDirectoryPeople`	`setMergeSources(List<String> mergeSources)` Optional.
`PeopleService.People.SearchDirectoryPeople`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`PeopleService.People.SearchDirectoryPeople`	`setPageSize(Integer pageSize)` Optional.
`PeopleService.People.SearchDirectoryPeople`	`setPageToken(String pageToken)` Optional.
`PeopleService.People.SearchDirectoryPeople`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`PeopleService.People.SearchDirectoryPeople`	`setQuery(String query)` Required.
`PeopleService.People.SearchDirectoryPeople`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`PeopleService.People.SearchDirectoryPeople`	`setReadMask(String readMask)` Required.
`PeopleService.People.SearchDirectoryPeople`	`setSources(List<String> sources)` Required.
`PeopleService.People.SearchDirectoryPeople`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`PeopleService.People.SearchDirectoryPeople`	`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
  - SearchDirectoryPeople
```
protected SearchDirectoryPeople()
```
    Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query. Create a request for the method "people.searchDirectoryPeople". 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.
    SearchDirectoryPeople#initialize(com.google.api.client.googleapis.service s.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<SearchDirectoryPeopleResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchDirectoryPeopleResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public PeopleService.People.SearchDirectoryPeople set$Xgafv(String $Xgafv)
```
    Description copied from class: PeopleServiceRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setAccessToken
```
public PeopleService.People.SearchDirectoryPeople setAccessToken(String accessToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setAlt
```
public PeopleService.People.SearchDirectoryPeople setAlt(String alt)
```
    Description copied from class: PeopleServiceRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setCallback
```
public PeopleService.People.SearchDirectoryPeople setCallback(String callback)
```
    Description copied from class: PeopleServiceRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setFields
```
public PeopleService.People.SearchDirectoryPeople setFields(String fields)
```
    Description copied from class: PeopleServiceRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setKey
```
public PeopleService.People.SearchDirectoryPeople 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<SearchDirectoryPeopleResponse>
  - setOauthToken
```
public PeopleService.People.SearchDirectoryPeople setOauthToken(String oauthToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setPrettyPrint
```
public PeopleService.People.SearchDirectoryPeople setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: PeopleServiceRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setQuotaUser
```
public PeopleService.People.SearchDirectoryPeople 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<SearchDirectoryPeopleResponse>
  - setUploadType
```
public PeopleService.People.SearchDirectoryPeople setUploadType(String uploadType)
```
    Description copied from class: PeopleServiceRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - setUploadProtocol
```
public PeopleService.People.SearchDirectoryPeople setUploadProtocol(String uploadProtocol)
```
    Description copied from class: PeopleServiceRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PeopleServiceRequest<SearchDirectoryPeopleResponse>
  - getMergeSources
```
public List<String> getMergeSources()
```
    Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
  - setMergeSources
```
public PeopleService.People.SearchDirectoryPeople setMergeSources(List<String> mergeSources)
```
    Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
  - setPageSize
```
public PeopleService.People.SearchDirectoryPeople setPageSize(Integer pageSize)
```
    Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
  - getPageToken
```
public String getPageToken()
```
    Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.
  - setPageToken
```
public PeopleService.People.SearchDirectoryPeople setPageToken(String pageToken)
```
    Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.
  - getQuery
```
public String getQuery()
```
    Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.
  - setQuery
```
public PeopleService.People.SearchDirectoryPeople setQuery(String query)
```
    Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.
  - getReadMask
```
public String getReadMask()
```
    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
  - setReadMask
```
public PeopleService.People.SearchDirectoryPeople setReadMask(String readMask)
```
    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
  - getSources
```
public List<String> getSources()
```
    Required. Directory sources to return.
  - setSources
```
public PeopleService.People.SearchDirectoryPeople setSources(List<String> sources)
```
    Required. Directory sources to return.
  - set
```
public PeopleService.People.SearchDirectoryPeople set(String parameterName,
                                                      Object value)
```
    Overrides:
    
    set in class PeopleServiceRequest<SearchDirectoryPeopleResponse>

Class PeopleService.People.SearchDirectoryPeople

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

SearchDirectoryPeople

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMergeSources

setMergeSources

getPageSize

setPageSize

getPageToken

setPageToken

getQuery

setQuery

getReadMask

setReadMask

getSources

setSources

set