PeopleService.ContactGroups.List (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<ListContactGroupsResponse>
        
        com.google.api.services.people.v1.PeopleService.ContactGroups.List

All Implemented Interfaces:: Cloneable, Map<String,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
  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 contact groups owned by the authenticated user.

Constructors
Modifier	Constructor and Description
`protected`	`List()` List all contact groups owned by the authenticated user.

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()`
`String`	`getGroupFields()` Optional.
`Integer`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`String`	`getSyncToken()` Optional.
`PeopleService.ContactGroups.List`	`set(String parameterName, Object value)`
`PeopleService.ContactGroups.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`PeopleService.ContactGroups.List`	`setAccessToken(String accessToken)` OAuth access token.
`PeopleService.ContactGroups.List`	`setAlt(String alt)` Data format for response.
`PeopleService.ContactGroups.List`	`setCallback(String callback)` JSONP
`PeopleService.ContactGroups.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`PeopleService.ContactGroups.List`	`setGroupFields(String groupFields)` Optional.
`PeopleService.ContactGroups.List`	`setKey(String key)` API key.
`PeopleService.ContactGroups.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`PeopleService.ContactGroups.List`	`setPageSize(Integer pageSize)` Optional.
`PeopleService.ContactGroups.List`	`setPageToken(String pageToken)` Optional.
`PeopleService.ContactGroups.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`PeopleService.ContactGroups.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`PeopleService.ContactGroups.List`	`setSyncToken(String syncToken)` Optional.
`PeopleService.ContactGroups.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`PeopleService.ContactGroups.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 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 IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListContactGroupsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListContactGroupsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public PeopleService.ContactGroups.List set$Xgafv(String $Xgafv)
```
    Description copied from class: PeopleServiceRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PeopleServiceRequest<ListContactGroupsResponse>
  - setAccessToken
```
public PeopleService.ContactGroups.List setAccessToken(String accessToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PeopleServiceRequest<ListContactGroupsResponse>
  - setAlt
```
public PeopleService.ContactGroups.List setAlt(String alt)
```
    Description copied from class: PeopleServiceRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PeopleServiceRequest<ListContactGroupsResponse>
  - setCallback
```
public PeopleService.ContactGroups.List setCallback(String callback)
```
    Description copied from class: PeopleServiceRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PeopleServiceRequest<ListContactGroupsResponse>
  - setFields
```
public PeopleService.ContactGroups.List setFields(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(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(String oauthToken)
```
    Description copied from class: PeopleServiceRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PeopleServiceRequest<ListContactGroupsResponse>
  - setPrettyPrint
```
public PeopleService.ContactGroups.List setPrettyPrint(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(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(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(String uploadProtocol)
```
    Description copied from class: PeopleServiceRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PeopleServiceRequest<ListContactGroupsResponse>
  - getGroupFields
```
public String getGroupFields()
```
    Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
  - setGroupFields
```
public PeopleService.ContactGroups.List setGroupFields(String groupFields)
```
    Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
  - setPageSize
```
public PeopleService.ContactGroups.List setPageSize(Integer pageSize)
```
    Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
  - getPageToken
```
public String getPageToken()
```
    Optional. 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(String pageToken)
```
    Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.
  - getSyncToken
```
public String getSyncToken()
```
    Optional. 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(String syncToken)
```
    Optional. 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(String parameterName,
                                            Object value)
```
    Overrides:
    
    set in class PeopleServiceRequest<ListContactGroupsResponse>

Class PeopleService.ContactGroups.List

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getGroupFields

setGroupFields

getPageSize

setPageSize

getPageToken

setPageToken

getSyncToken

setSyncToken

set