com.google.api.services.people.v1

Class PeopleService.OtherContacts.List

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<ListOtherContactsResponse>

com.google.api.services.people.v1.PeopleService.OtherContacts.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

PeopleService.OtherContacts

public class PeopleService.OtherContacts.List
extends PeopleServiceRequest<ListOtherContactsResponse>

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	List() List all "Other contacts", that is contacts that are not in a contact group.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() Optional.
String	getPageToken() Optional.
String	getReadMask() Required.
Boolean	getRequestSyncToken() Optional.
List<String>	getSources() Optional.
String	getSyncToken() Optional.
PeopleService.OtherContacts.List	set(String parameterName, Object value)
PeopleService.OtherContacts.List	set$Xgafv(String $Xgafv) V1 error format.
PeopleService.OtherContacts.List	setAccessToken(String accessToken) OAuth access token.
PeopleService.OtherContacts.List	setAlt(String alt) Data format for response.
PeopleService.OtherContacts.List	setCallback(String callback) JSONP
PeopleService.OtherContacts.List	setFields(String fields) Selector specifying which fields to include in a partial response.
PeopleService.OtherContacts.List	setKey(String key) API key.
PeopleService.OtherContacts.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
PeopleService.OtherContacts.List	setPageSize(Integer pageSize) Optional.
PeopleService.OtherContacts.List	setPageToken(String pageToken) Optional.
PeopleService.OtherContacts.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
PeopleService.OtherContacts.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
PeopleService.OtherContacts.List	setReadMask(String readMask) Required.
PeopleService.OtherContacts.List	setRequestSyncToken(Boolean requestSyncToken) Optional.
PeopleService.OtherContacts.List	setSources(List<String> sources) Optional.
PeopleService.OtherContacts.List	setSyncToken(String syncToken) Optional.
PeopleService.OtherContacts.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
PeopleService.OtherContacts.List	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

List

protected List()

List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an [google.rpc.ErrorInfo](https://cloud.google.com/apis/design/errors#error_info) with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. 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 user's other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed). Create a request for the method "otherContacts.list". 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<ListOtherContactsResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public PeopleService.OtherContacts.List set$Xgafv(String $Xgafv)

Description copied from class: PeopleServiceRequest

V1 error format.

Overrides:

set$Xgafv in class PeopleServiceRequest<ListOtherContactsResponse>

setAccessToken

public PeopleService.OtherContacts.List setAccessToken(String accessToken)

Description copied from class: PeopleServiceRequest

OAuth access token.

Overrides:

setAccessToken in class PeopleServiceRequest<ListOtherContactsResponse>

setAlt

public PeopleService.OtherContacts.List setAlt(String alt)

Description copied from class: PeopleServiceRequest

Data format for response.

Overrides:

setAlt in class PeopleServiceRequest<ListOtherContactsResponse>

setCallback

public PeopleService.OtherContacts.List setCallback(String callback)

Description copied from class: PeopleServiceRequest

JSONP

Overrides:

setCallback in class PeopleServiceRequest<ListOtherContactsResponse>

setFields

public PeopleService.OtherContacts.List setFields(String fields)

Description copied from class: PeopleServiceRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PeopleServiceRequest<ListOtherContactsResponse>

setKey

public PeopleService.OtherContacts.List 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<ListOtherContactsResponse>

setOauthToken

public PeopleService.OtherContacts.List setOauthToken(String oauthToken)

Description copied from class: PeopleServiceRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PeopleServiceRequest<ListOtherContactsResponse>

setPrettyPrint

public PeopleService.OtherContacts.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: PeopleServiceRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PeopleServiceRequest<ListOtherContactsResponse>

setQuotaUser

public PeopleService.OtherContacts.List 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<ListOtherContactsResponse>

setUploadType

public PeopleService.OtherContacts.List setUploadType(String uploadType)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadType in class PeopleServiceRequest<ListOtherContactsResponse>

setUploadProtocol

public PeopleService.OtherContacts.List setUploadProtocol(String uploadProtocol)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadProtocol in class PeopleServiceRequest<ListOtherContactsResponse>

getPageSize

public Integer getPageSize()

Optional. The number of "Other contacts" 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.OtherContacts.List setPageSize(Integer pageSize)

Optional. The number of "Other contacts" 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 `otherContacts.list` must match the first call that provided the page token.

setPageToken

public PeopleService.OtherContacts.List 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 `otherContacts.list` 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. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, 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.OtherContacts.List 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. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, 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` on the last page of results. 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 `otherContacts.list`.

setRequestSyncToken

public PeopleService.OtherContacts.List setRequestSyncToken(Boolean requestSyncToken)

Optional. Whether the response should return `next_sync_token` on the last page of results. 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 `otherContacts.list`.

getSources

public List<String> getSources()

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.

setSources

public PeopleService.OtherContacts.List setSources(List<String> sources)

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.

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 `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.

setSyncToken

public PeopleService.OtherContacts.List 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 `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.

set

public PeopleService.OtherContacts.List set(String parameterName,
                                            Object value)

Overrides:

set in class PeopleServiceRequest<ListOtherContactsResponse>