com.google.api.services.people.v1

Class PeopleService.ContactGroups.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<ListContactGroupsResponse>

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

All Implemented Interfaces:

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

Enclosing class:

PeopleService.ContactGroups

public class PeopleService.ContactGroups.List
extends PeopleServiceRequest<ListContactGroupsResponse>

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.ContactGroups.List() List all contact groups owned by the authenticated user.

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 maximum number of resources to return.
java.lang.String	getPageToken() The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list).
java.lang.String	getSyncToken() A sync token, returned by a previous call to `contactgroups.list`.
PeopleService.ContactGroups.List	set(java.lang.String parameterName, java.lang.Object value)
PeopleService.ContactGroups.List	set$Xgafv(java.lang.String $Xgafv) V1 error format.
PeopleService.ContactGroups.List	setAccessToken(java.lang.String accessToken) OAuth access token.
PeopleService.ContactGroups.List	setAlt(java.lang.String alt) Data format for response.
PeopleService.ContactGroups.List	setBearerToken(java.lang.String bearerToken) OAuth bearer token.
PeopleService.ContactGroups.List	setCallback(java.lang.String callback) JSONP
PeopleService.ContactGroups.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
PeopleService.ContactGroups.List	setKey(java.lang.String key) API key.
PeopleService.ContactGroups.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
PeopleService.ContactGroups.List	setPageSize(java.lang.Integer pageSize) The maximum number of resources to return.
PeopleService.ContactGroups.List	setPageToken(java.lang.String pageToken) The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list).
PeopleService.ContactGroups.List	setPp(java.lang.Boolean pp) Pretty-print response.
PeopleService.ContactGroups.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
PeopleService.ContactGroups.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
PeopleService.ContactGroups.List	setSyncToken(java.lang.String syncToken) A sync token, returned by a previous call to `contactgroups.list`.
PeopleService.ContactGroups.List	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
PeopleService.ContactGroups.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.ContactGroups.List

protected PeopleService.ContactGroups.List()

List all contact groups owned by the authenticated user. Members of the contact groups are not populated. Create a request for the method "contactGroups.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 java.io.IOException

Overrides:

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

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

Throws:

java.io.IOException

set$Xgafv

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

Description copied from class: PeopleServiceRequest

V1 error format.

Overrides:

set$Xgafv in class PeopleServiceRequest<ListContactGroupsResponse>

setAccessToken

public PeopleService.ContactGroups.List setAccessToken(java.lang.String accessToken)

Description copied from class: PeopleServiceRequest

OAuth access token.

Overrides:

setAccessToken in class PeopleServiceRequest<ListContactGroupsResponse>

setAlt

public PeopleService.ContactGroups.List setAlt(java.lang.String alt)

Description copied from class: PeopleServiceRequest

Data format for response.

Overrides:

setAlt in class PeopleServiceRequest<ListContactGroupsResponse>

setBearerToken

public PeopleService.ContactGroups.List setBearerToken(java.lang.String bearerToken)

Description copied from class: PeopleServiceRequest

OAuth bearer token.

Overrides:

setBearerToken in class PeopleServiceRequest<ListContactGroupsResponse>

setCallback

public PeopleService.ContactGroups.List setCallback(java.lang.String callback)

Description copied from class: PeopleServiceRequest

JSONP

Overrides:

setCallback in class PeopleServiceRequest<ListContactGroupsResponse>

setFields

public PeopleService.ContactGroups.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<ListContactGroupsResponse>

setKey

public PeopleService.ContactGroups.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<ListContactGroupsResponse>

setOauthToken

public PeopleService.ContactGroups.List setOauthToken(java.lang.String oauthToken)

Description copied from class: PeopleServiceRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PeopleServiceRequest<ListContactGroupsResponse>

setPp

public PeopleService.ContactGroups.List setPp(java.lang.Boolean pp)

Description copied from class: PeopleServiceRequest

Pretty-print response.

Overrides:

setPp in class PeopleServiceRequest<ListContactGroupsResponse>

setPrettyPrint

public PeopleService.ContactGroups.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: PeopleServiceRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PeopleServiceRequest<ListContactGroupsResponse>

setQuotaUser

public PeopleService.ContactGroups.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<ListContactGroupsResponse>

setUploadType

public PeopleService.ContactGroups.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<ListContactGroupsResponse>

setUploadProtocol

public PeopleService.ContactGroups.List setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: PeopleServiceRequest

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

Overrides:

setUploadProtocol in class PeopleServiceRequest<ListContactGroupsResponse>

getPageToken

public java.lang.String getPageToken()

The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.

setPageToken

public PeopleService.ContactGroups.List setPageToken(java.lang.String pageToken)

The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.

getPageSize

public java.lang.Integer getPageSize()

The maximum number of resources to return.

setPageSize

public PeopleService.ContactGroups.List setPageSize(java.lang.Integer pageSize)

The maximum number of resources to return.

getSyncToken

public java.lang.String getSyncToken()

A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.

setSyncToken

public PeopleService.ContactGroups.List setSyncToken(java.lang.String syncToken)

A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.

set

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

Overrides:

set in class PeopleServiceRequest<ListContactGroupsResponse>