Directory.Groups.List (Admin SDK API directory

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.directory.DirectoryRequest<Groups>
        
        com.google.api.services.directory.Directory.Groups.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Directory.Groups
```
public class Directory.Groups.List
extends DirectoryRequest<Groups>
```

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 List()
Retrieve all groups of a domain or of a user given a userKey (paginated) Create a request for the method "groups.list".

Constructors
Modifier	Constructor and Description
`protected`	`List()` Retrieve all groups of a domain or of a user given a userKey (paginated) Create a request for the method "groups.list".

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getCustomer()` The unique ID for the customer's Google Workspace account.
`String`	`getDomain()` The domain name.
`Integer`	`getMaxResults()` Maximum number of results to return.
`String`	`getOrderBy()` Column to use for sorting results
`String`	`getPageToken()` Token to specify next page in the list
`String`	`getQuery()` Query string search.
`String`	`getSortOrder()` Whether to return results in ascending or descending order.
`String`	`getUserKey()` Email or immutable ID of the user if only those groups are to be listed, the given user is a member of.
`Directory.Groups.List`	`set(String parameterName, Object value)`
`Directory.Groups.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Directory.Groups.List`	`setAccessToken(String accessToken)` OAuth access token.
`Directory.Groups.List`	`setAlt(String alt)` Data format for response.
`Directory.Groups.List`	`setCallback(String callback)` JSONP
`Directory.Groups.List`	`setCustomer(String customer)` The unique ID for the customer's Google Workspace account.
`Directory.Groups.List`	`setDomain(String domain)` The domain name.
`Directory.Groups.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Directory.Groups.List`	`setKey(String key)` API key.
`Directory.Groups.List`	`setMaxResults(Integer maxResults)` Maximum number of results to return.
`Directory.Groups.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Directory.Groups.List`	`setOrderBy(String orderBy)` Column to use for sorting results
`Directory.Groups.List`	`setPageToken(String pageToken)` Token to specify next page in the list
`Directory.Groups.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Directory.Groups.List`	`setQuery(String query)` Query string search.
`Directory.Groups.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Directory.Groups.List`	`setSortOrder(String sortOrder)` Whether to return results in ascending or descending order.
`Directory.Groups.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Directory.Groups.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Directory.Groups.List`	`setUserKey(String userKey)` Email or immutable ID of the user if only those groups are to be listed, the given user is a member of.

Methods inherited from class com.google.api.services.directory.DirectoryRequest
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
  - List
```
protected List()
```
    Retrieve all groups of a domain or of a user given a userKey (paginated) Create a request for the method "groups.list". This request holds the parameters needed by the the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Directory.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 HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<Groups>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Groups>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Directory.Groups.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DirectoryRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DirectoryRequest<Groups>
  - setAccessToken
```
public Directory.Groups.List setAccessToken(String accessToken)
```
    Description copied from class: DirectoryRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DirectoryRequest<Groups>
  - setAlt
```
public Directory.Groups.List setAlt(String alt)
```
    Description copied from class: DirectoryRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DirectoryRequest<Groups>
  - setCallback
```
public Directory.Groups.List setCallback(String callback)
```
    Description copied from class: DirectoryRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DirectoryRequest<Groups>
  - setFields
```
public Directory.Groups.List setFields(String fields)
```
    Description copied from class: DirectoryRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DirectoryRequest<Groups>
  - setKey
```
public Directory.Groups.List setKey(String key)
```
    Description copied from class: DirectoryRequest
    
    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 DirectoryRequest<Groups>
  - setOauthToken
```
public Directory.Groups.List setOauthToken(String oauthToken)
```
    Description copied from class: DirectoryRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DirectoryRequest<Groups>
  - setPrettyPrint
```
public Directory.Groups.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DirectoryRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DirectoryRequest<Groups>
  - setQuotaUser
```
public Directory.Groups.List setQuotaUser(String quotaUser)
```
    Description copied from class: DirectoryRequest
    
    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 DirectoryRequest<Groups>
  - setUploadType
```
public Directory.Groups.List setUploadType(String uploadType)
```
    Description copied from class: DirectoryRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DirectoryRequest<Groups>
  - setUploadProtocol
```
public Directory.Groups.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DirectoryRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DirectoryRequest<Groups>
  - getCustomer
```
public String getCustomer()
```
    The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
  - setCustomer
```
public Directory.Groups.List setCustomer(String customer)
```
    The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin- sdk/directory/v1/reference/users)
  - getDomain
```
public String getDomain()
```
    The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.
  - setDomain
```
public Directory.Groups.List setDomain(String domain)
```
    The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of results to return. Max allowed value is 200. [default: 200] [minimum: 1]
  - setMaxResults
```
public Directory.Groups.List setMaxResults(Integer maxResults)
```
    Maximum number of results to return. Max allowed value is 200.
  - getOrderBy
```
public String getOrderBy()
```
    Column to use for sorting results
  - setOrderBy
```
public Directory.Groups.List setOrderBy(String orderBy)
```
    Column to use for sorting results
  - getPageToken
```
public String getPageToken()
```
    Token to specify next page in the list
  - setPageToken
```
public Directory.Groups.List setPageToken(String pageToken)
```
    Token to specify next page in the list
  - getQuery
```
public String getQuery()
```
    Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
  - setQuery
```
public Directory.Groups.List setQuery(String query)
```
    Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
  - getSortOrder
```
public String getSortOrder()
```
    Whether to return results in ascending or descending order. Only of use when orderBy is also used
  - setSortOrder
```
public Directory.Groups.List setSortOrder(String sortOrder)
```
    Whether to return results in ascending or descending order. Only of use when orderBy is also used
  - getUserKey
```
public String getUserKey()
```
    Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.
  - setUserKey
```
public Directory.Groups.List setUserKey(String userKey)
```
    Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.
  - set
```
public Directory.Groups.List set(String parameterName,
                                 Object value)
```
    Overrides:
    
    set in class DirectoryRequest<Groups>

Class Directory.Groups.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.directory.DirectoryRequest

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

getCustomer

setCustomer

getDomain

setDomain

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getQuery

setQuery

getSortOrder

setSortOrder

getUserKey

setUserKey

set