com.google.api.services.people.v1

Class PeopleService.People.Connections.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<ListConnectionsResponse>

com.google.api.services.people.v1.PeopleService.People.Connections.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

PeopleService.People.Connections

public class PeopleService.People.Connections.List
extends PeopleServiceRequest<ListConnectionsResponse>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.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	PeopleService.People.Connections.List(java.lang.String resourceName) Provides a list of the authenticated user's contacts merged with any connected profiles.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.Integer	getPageSize() The number of connections to include in the response.
java.lang.String	getPageToken() The token of the page to be returned.
java.lang.String	getPersonFields() Required.** A field mask to restrict which fields on each person are returned.
java.lang.String	getRequestMaskIncludeField() Required.** Comma-separated list of person fields to be included in the response.
java.lang.Boolean	getRequestSyncToken() Whether the response should include a sync token, which can be used to get all changes since the last request.
java.lang.String	getResourceName() The resource name to return connections for.
java.lang.String	getSortOrder() The order in which the connections should be sorted.
java.lang.String	getSyncToken() A sync token returned by a previous call to `people.connections.list`.
PeopleService.People.Connections.List	set(java.lang.String parameterName, java.lang.Object value)
PeopleService.People.Connections.List	set$Xgafv(java.lang.String $Xgafv) V1 error format.
PeopleService.People.Connections.List	setAccessToken(java.lang.String accessToken) OAuth access token.
PeopleService.People.Connections.List	setAlt(java.lang.String alt) Data format for response.
PeopleService.People.Connections.List	setBearerToken(java.lang.String bearerToken) OAuth bearer token.
PeopleService.People.Connections.List	setCallback(java.lang.String callback) JSONP
PeopleService.People.Connections.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
PeopleService.People.Connections.List	setKey(java.lang.String key) API key.
PeopleService.People.Connections.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
PeopleService.People.Connections.List	setPageSize(java.lang.Integer pageSize) The number of connections to include in the response.
PeopleService.People.Connections.List	setPageToken(java.lang.String pageToken) The token of the page to be returned.
PeopleService.People.Connections.List	setPersonFields(java.lang.String personFields) **Required.** A field mask to restrict which fields on each person are returned.
PeopleService.People.Connections.List	setPp(java.lang.Boolean pp) Pretty-print response.
PeopleService.People.Connections.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
PeopleService.People.Connections.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
PeopleService.People.Connections.List	setRequestMaskIncludeField(java.lang.String requestMaskIncludeField) **Required.** Comma-separated list of person fields to be included in the response.
PeopleService.People.Connections.List	setRequestSyncToken(java.lang.Boolean requestSyncToken) Whether the response should include a sync token, which can be used to get all changes since the last request.
PeopleService.People.Connections.List	setResourceName(java.lang.String resourceName) The resource name to return connections for.
PeopleService.People.Connections.List	setSortOrder(java.lang.String sortOrder) The order in which the connections should be sorted.
PeopleService.People.Connections.List	setSyncToken(java.lang.String syncToken) A sync token returned by a previous call to `people.connections.list`.
PeopleService.People.Connections.List	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
PeopleService.People.Connections.List	setUploadType(java.lang.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, getBearerToken, getCallback, getFields, getKey, getOauthToken, getPp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PeopleService.People.Connections.List

protected PeopleService.People.Connections.List(java.lang.String resourceName)

Provides a list of the authenticated user's contacts merged with any connected profiles. The request throws a 400 error if 'personFields' is not specified. Create a request for the method "connections.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.

Parameters:

resourceName - The resource name to return connections for. Only `people/me` is valid.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListConnectionsResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

java.io.IOException

set$Xgafv

public PeopleService.People.Connections.List set$Xgafv(java.lang.String $Xgafv)

Description copied from class: PeopleServiceRequest

V1 error format.

Overrides:

set$Xgafv in class PeopleServiceRequest<ListConnectionsResponse>

setAccessToken

public PeopleService.People.Connections.List setAccessToken(java.lang.String accessToken)

Description copied from class: PeopleServiceRequest

OAuth access token.

Overrides:

setAccessToken in class PeopleServiceRequest<ListConnectionsResponse>

setAlt

public PeopleService.People.Connections.List setAlt(java.lang.String alt)

Description copied from class: PeopleServiceRequest

Data format for response.

Overrides:

setAlt in class PeopleServiceRequest<ListConnectionsResponse>

setBearerToken

public PeopleService.People.Connections.List setBearerToken(java.lang.String bearerToken)

Description copied from class: PeopleServiceRequest

OAuth bearer token.

Overrides:

setBearerToken in class PeopleServiceRequest<ListConnectionsResponse>

setCallback

public PeopleService.People.Connections.List setCallback(java.lang.String callback)

Description copied from class: PeopleServiceRequest

JSONP

Overrides:

setCallback in class PeopleServiceRequest<ListConnectionsResponse>

setFields

public PeopleService.People.Connections.List setFields(java.lang.String fields)

Description copied from class: PeopleServiceRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PeopleServiceRequest<ListConnectionsResponse>

setKey

public PeopleService.People.Connections.List setKey(java.lang.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<ListConnectionsResponse>

setOauthToken

public PeopleService.People.Connections.List setOauthToken(java.lang.String oauthToken)

Description copied from class: PeopleServiceRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PeopleServiceRequest<ListConnectionsResponse>

setPp

public PeopleService.People.Connections.List setPp(java.lang.Boolean pp)

Description copied from class: PeopleServiceRequest

Pretty-print response.

Overrides:

setPp in class PeopleServiceRequest<ListConnectionsResponse>

setPrettyPrint

public PeopleService.People.Connections.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: PeopleServiceRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PeopleServiceRequest<ListConnectionsResponse>

setQuotaUser

public PeopleService.People.Connections.List setQuotaUser(java.lang.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<ListConnectionsResponse>

setUploadType

public PeopleService.People.Connections.List setUploadType(java.lang.String uploadType)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadType in class PeopleServiceRequest<ListConnectionsResponse>

setUploadProtocol

public PeopleService.People.Connections.List setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadProtocol in class PeopleServiceRequest<ListConnectionsResponse>

getResourceName

public java.lang.String getResourceName()

The resource name to return connections for. Only `people/me` is valid.

setResourceName

public PeopleService.People.Connections.List setResourceName(java.lang.String resourceName)

The resource name to return connections for. Only `people/me` is valid.

getSortOrder

public java.lang.String getSortOrder()

The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.

setSortOrder

public PeopleService.People.Connections.List setSortOrder(java.lang.String sortOrder)

The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.

getRequestSyncToken

public java.lang.Boolean getRequestSyncToken()

Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.

setRequestSyncToken

public PeopleService.People.Connections.List setRequestSyncToken(java.lang.Boolean requestSyncToken)

Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.

getPageToken

public java.lang.String getPageToken()

The token of the page to be returned.

setPageToken

public PeopleService.People.Connections.List setPageToken(java.lang.String pageToken)

The token of the page to be returned.

getPageSize

public java.lang.Integer getPageSize()

The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.

setPageSize

public PeopleService.People.Connections.List setPageSize(java.lang.Integer pageSize)

The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.

getRequestMaskIncludeField

public java.lang.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.Connections.List setRequestMaskIncludeField(java.lang.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`.

getSyncToken

public java.lang.String getSyncToken()

A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit.

setSyncToken

public PeopleService.People.Connections.List setSyncToken(java.lang.String syncToken)

A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit.

getPersonFields

public java.lang.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 * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * skills * taglines * urls

setPersonFields

public PeopleService.People.Connections.List setPersonFields(java.lang.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 * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * skills * taglines * urls

set

public PeopleService.People.Connections.List set(java.lang.String parameterName,
                                        java.lang.Object value)

Overrides:

set in class PeopleServiceRequest<ListConnectionsResponse>