PeopleService.People.SearchContacts (People API v1-rev20210315-1.31.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<SearchResponse>
        
        com.google.api.services.people.v1.PeopleService.People.SearchContacts

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

Enclosing class:: PeopleService.People

public class PeopleService.People.SearchContacts
extends PeopleServiceRequest<SearchResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected SearchContacts()
Provides a list of contacts in the authenticated user's grouped contacts that matches the search query.

Constructors
Modifier	Constructor and Description
`protected`	`SearchContacts()` Provides a list of contacts in the authenticated user's grouped contacts that matches the search query.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`Integer`	`getPageSize()` Optional.
`String`	`getQuery()` Required.
`String`	`getReadMask()` Required.
`PeopleService.People.SearchContacts`	`set(String parameterName, Object value)`
`PeopleService.People.SearchContacts`	`set$Xgafv(String $Xgafv)` V1 error format.
`PeopleService.People.SearchContacts`	`setAccessToken(String accessToken)` OAuth access token.
`PeopleService.People.SearchContacts`	`setAlt(String alt)` Data format for response.
`PeopleService.People.SearchContacts`	`setCallback(String callback)` JSONP
`PeopleService.People.SearchContacts`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`PeopleService.People.SearchContacts`	`setKey(String key)` API key.
`PeopleService.People.SearchContacts`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`PeopleService.People.SearchContacts`	`setPageSize(Integer pageSize)` Optional.
`PeopleService.People.SearchContacts`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`PeopleService.People.SearchContacts`	`setQuery(String query)` Required.
`PeopleService.People.SearchContacts`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`PeopleService.People.SearchContacts`	`setReadMask(String readMask)` Required.
`PeopleService.People.SearchContacts`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`PeopleService.People.SearchContacts`	`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.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
  - SearchContacts
```
protected SearchContacts()
```
    Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. Create a request for the method "people.searchContacts". 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.
    SearchContacts#initialize(com.google.api.client.googleapis.services.AbstractGoogleCl ientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<SearchResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<SearchResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public PeopleService.People.SearchContacts set$Xgafv(String $Xgafv)
```
    Description copied from class: PeopleServiceRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PeopleServiceRequest<SearchResponse>
  - setAccessToken
```
public PeopleService.People.SearchContacts setAccessToken(String accessToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PeopleServiceRequest<SearchResponse>
  - setAlt
```
public PeopleService.People.SearchContacts setAlt(String alt)
```
    Description copied from class: PeopleServiceRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PeopleServiceRequest<SearchResponse>
  - setCallback
```
public PeopleService.People.SearchContacts setCallback(String callback)
```
    Description copied from class: PeopleServiceRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PeopleServiceRequest<SearchResponse>
  - setFields
```
public PeopleService.People.SearchContacts setFields(String fields)
```
    Description copied from class: PeopleServiceRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class PeopleServiceRequest<SearchResponse>
  - setKey
```
public PeopleService.People.SearchContacts 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<SearchResponse>
  - setOauthToken
```
public PeopleService.People.SearchContacts setOauthToken(String oauthToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PeopleServiceRequest<SearchResponse>
  - setPrettyPrint
```
public PeopleService.People.SearchContacts setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: PeopleServiceRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class PeopleServiceRequest<SearchResponse>
  - setQuotaUser
```
public PeopleService.People.SearchContacts 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<SearchResponse>
  - setUploadType
```
public PeopleService.People.SearchContacts setUploadType(String uploadType)
```
    Description copied from class: PeopleServiceRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class PeopleServiceRequest<SearchResponse>
  - setUploadProtocol
```
public PeopleService.People.SearchContacts setUploadProtocol(String uploadProtocol)
```
    Description copied from class: PeopleServiceRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PeopleServiceRequest<SearchResponse>
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The number of results to return.
  - setPageSize
```
public PeopleService.People.SearchContacts setPageSize(Integer pageSize)
```
    Optional. The number of results to return.
  - getQuery
```
public String getQuery()
```
    Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
  - setQuery
```
public PeopleService.People.SearchContacts setQuery(String query)
```
    Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
  - 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.SearchContacts 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
  - set
```
public PeopleService.People.SearchContacts set(String parameterName,
                                               Object value)
```
    Overrides:
    
    set in class PeopleServiceRequest<SearchResponse>

Class PeopleService.People.SearchContacts

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

SearchContacts

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getPageSize

setPageSize

getQuery

setQuery

getReadMask

setReadMask

set