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

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

Enclosing class:: PeopleService.People

public class PeopleService.People.ListDirectoryPeople
extends PeopleServiceRequest<ListDirectoryPeopleResponse>

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 ListDirectoryPeople()
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.

Constructors
Modifier	Constructor and Description
`protected`	`ListDirectoryPeople()` Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.

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`	`getReadMask()` Required.
`Boolean`	`getRequestSyncToken()` Optional.
`List<String>`	`getSources()` Required.
`String`	`getSyncToken()` Optional.
`PeopleService.People.ListDirectoryPeople`	`set(String parameterName, Object value)`
`PeopleService.People.ListDirectoryPeople`	`set$Xgafv(String $Xgafv)` V1 error format.
`PeopleService.People.ListDirectoryPeople`	`setAccessToken(String accessToken)` OAuth access token.
`PeopleService.People.ListDirectoryPeople`	`setAlt(String alt)` Data format for response.
`PeopleService.People.ListDirectoryPeople`	`setCallback(String callback)` JSONP
`PeopleService.People.ListDirectoryPeople`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`PeopleService.People.ListDirectoryPeople`	`setKey(String key)` API key.
`PeopleService.People.ListDirectoryPeople`	`setMergeSources(List<String> mergeSources)` Optional.
`PeopleService.People.ListDirectoryPeople`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`PeopleService.People.ListDirectoryPeople`	`setPageSize(Integer pageSize)` Optional.
`PeopleService.People.ListDirectoryPeople`	`setPageToken(String pageToken)` Optional.
`PeopleService.People.ListDirectoryPeople`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`PeopleService.People.ListDirectoryPeople`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`PeopleService.People.ListDirectoryPeople`	`setReadMask(String readMask)` Required.
`PeopleService.People.ListDirectoryPeople`	`setRequestSyncToken(Boolean requestSyncToken)` Optional.
`PeopleService.People.ListDirectoryPeople`	`setSources(List<String> sources)` Required.
`PeopleService.People.ListDirectoryPeople`	`setSyncToken(String syncToken)` Optional.
`PeopleService.People.ListDirectoryPeople`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`PeopleService.People.ListDirectoryPeople`	`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
  - ListDirectoryPeople
```
protected ListDirectoryPeople()
```
    Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directory_people_that_have_changed). Create a request for the method "people.listDirectoryPeople". 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.
    ListDirectoryPeople#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<ListDirectoryPeopleResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListDirectoryPeopleResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public PeopleService.People.ListDirectoryPeople set$Xgafv(String $Xgafv)
```
    Description copied from class: PeopleServiceRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setAccessToken
```
public PeopleService.People.ListDirectoryPeople setAccessToken(String accessToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setAlt
```
public PeopleService.People.ListDirectoryPeople setAlt(String alt)
```
    Description copied from class: PeopleServiceRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setCallback
```
public PeopleService.People.ListDirectoryPeople setCallback(String callback)
```
    Description copied from class: PeopleServiceRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setFields
```
public PeopleService.People.ListDirectoryPeople setFields(String fields)
```
    Description copied from class: PeopleServiceRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setKey
```
public PeopleService.People.ListDirectoryPeople 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<ListDirectoryPeopleResponse>
  - setOauthToken
```
public PeopleService.People.ListDirectoryPeople setOauthToken(String oauthToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setPrettyPrint
```
public PeopleService.People.ListDirectoryPeople setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: PeopleServiceRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setQuotaUser
```
public PeopleService.People.ListDirectoryPeople 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<ListDirectoryPeopleResponse>
  - setUploadType
```
public PeopleService.People.ListDirectoryPeople setUploadType(String uploadType)
```
    Description copied from class: PeopleServiceRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - setUploadProtocol
```
public PeopleService.People.ListDirectoryPeople setUploadProtocol(String uploadProtocol)
```
    Description copied from class: PeopleServiceRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PeopleServiceRequest<ListDirectoryPeopleResponse>
  - 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.ListDirectoryPeople 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 1000, inclusive. Defaults to 100 if not set or set to 0.
  - setPageSize
```
public PeopleService.People.ListDirectoryPeople setPageSize(Integer pageSize)
```
    Optional. The number of people to include in the response. Valid values are between 1 and 1000, 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 `people.listDirectoryPeople` must match the first call that provided the page token.
  - setPageToken
```
public PeopleService.People.ListDirectoryPeople 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 `people.listDirectoryPeople` must match the first call that provided the page token.
  - 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.ListDirectoryPeople 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
  - getRequestSyncToken
```
public Boolean getRequestSyncToken()
```
    Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.
  - setRequestSyncToken
```
public PeopleService.People.ListDirectoryPeople setRequestSyncToken(Boolean requestSyncToken)
```
    Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.
  - getSources
```
public List<String> getSources()
```
    Required. Directory sources to return.
  - setSources
```
public PeopleService.People.ListDirectoryPeople setSources(List<String> sources)
```
    Required. Directory sources to return.
  - getSyncToken
```
public String getSyncToken()
```
    Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.
  - setSyncToken
```
public PeopleService.People.ListDirectoryPeople setSyncToken(String syncToken)
```
    Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.
  - set
```
public PeopleService.People.ListDirectoryPeople set(String parameterName,
                                                    Object value)
```
    Overrides:
    
    set in class PeopleServiceRequest<ListDirectoryPeopleResponse>

Class PeopleService.People.ListDirectoryPeople

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

ListDirectoryPeople

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMergeSources

setMergeSources

getPageSize

setPageSize

getPageToken

setPageToken

getReadMask

setReadMask

getRequestSyncToken

setRequestSyncToken

getSources

setSources

getSyncToken

setSyncToken

set