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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

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

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()
Retrieves a paginated list of either deleted users or all users in a domain.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Retrieves a paginated list of either deleted users or all users in a domain.

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`	`getCustomFieldMask()` A comma-separated list of schema names.
`String`	`getDomain()` The domain name.
`String`	`getEvent()` Event on which subscription is intended (if subscribing)
`Integer`	`getMaxResults()` Maximum number of results to return.
`String`	`getOrderBy()` Property to use for sorting results.
`String`	`getPageToken()` Token to specify next page in the list
`String`	`getProjection()` What subset of fields to fetch for this user.
`String`	`getQuery()` Query string for searching user fields.
`String`	`getShowDeleted()` If set to `true`, retrieves the list of deleted users.
`String`	`getSortOrder()` Whether to return results in ascending or descending order.
`String`	`getViewType()` Whether to fetch the administrator-only or domain-wide public view of the user.
`Directory.Users.List`	`set(String parameterName, Object value)`
`Directory.Users.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Directory.Users.List`	`setAccessToken(String accessToken)` OAuth access token.
`Directory.Users.List`	`setAlt(String alt)` Data format for response.
`Directory.Users.List`	`setCallback(String callback)` JSONP
`Directory.Users.List`	`setCustomer(String customer)` The unique ID for the customer's Google Workspace account.
`Directory.Users.List`	`setCustomFieldMask(String customFieldMask)` A comma-separated list of schema names.
`Directory.Users.List`	`setDomain(String domain)` The domain name.
`Directory.Users.List`	`setEvent(String event)` Event on which subscription is intended (if subscribing)
`Directory.Users.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Directory.Users.List`	`setKey(String key)` API key.
`Directory.Users.List`	`setMaxResults(Integer maxResults)` Maximum number of results to return.
`Directory.Users.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Directory.Users.List`	`setOrderBy(String orderBy)` Property to use for sorting results.
`Directory.Users.List`	`setPageToken(String pageToken)` Token to specify next page in the list
`Directory.Users.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Directory.Users.List`	`setProjection(String projection)` What subset of fields to fetch for this user.
`Directory.Users.List`	`setQuery(String query)` Query string for searching user fields.
`Directory.Users.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Directory.Users.List`	`setShowDeleted(String showDeleted)` If set to `true`, retrieves the list of deleted users.
`Directory.Users.List`	`setSortOrder(String sortOrder)` Whether to return results in ascending or descending order.
`Directory.Users.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Directory.Users.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Directory.Users.List`	`setViewType(String viewType)` Whether to fetch the administrator-only or domain-wide public view of the user.

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()
```
    Retrieves a paginated list of either deleted users or all users in a domain. Create a request for the method "users.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<Users>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Users>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Directory.Users.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DirectoryRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DirectoryRequest<Users>
  - setAccessToken
```
public Directory.Users.List setAccessToken(String accessToken)
```
    Description copied from class: DirectoryRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DirectoryRequest<Users>
  - setAlt
```
public Directory.Users.List setAlt(String alt)
```
    Description copied from class: DirectoryRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DirectoryRequest<Users>
  - setCallback
```
public Directory.Users.List setCallback(String callback)
```
    Description copied from class: DirectoryRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DirectoryRequest<Users>
  - setFields
```
public Directory.Users.List setFields(String fields)
```
    Description copied from class: DirectoryRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DirectoryRequest<Users>
  - setKey
```
public Directory.Users.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<Users>
  - setOauthToken
```
public Directory.Users.List setOauthToken(String oauthToken)
```
    Description copied from class: DirectoryRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DirectoryRequest<Users>
  - setPrettyPrint
```
public Directory.Users.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DirectoryRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DirectoryRequest<Users>
  - setQuotaUser
```
public Directory.Users.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<Users>
  - setUploadType
```
public Directory.Users.List setUploadType(String uploadType)
```
    Description copied from class: DirectoryRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DirectoryRequest<Users>
  - setUploadProtocol
```
public Directory.Users.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DirectoryRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DirectoryRequest<Users>
  - getCustomFieldMask
```
public String getCustomFieldMask()
```
    A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.
  - setCustomFieldMask
```
public Directory.Users.List setCustomFieldMask(String customFieldMask)
```
    A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.
  - 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. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain` parameter must be provided.
  - setCustomer
```
public Directory.Users.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. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain` parameter must be provided.
  - 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. Either the `customer` or the `domain` parameter must be provided.
  - setDomain
```
public Directory.Users.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. Either the `customer` or the `domain` parameter must be provided.
  - getEvent
```
public String getEvent()
```
    Event on which subscription is intended (if subscribing)
  - setEvent
```
public Directory.Users.List setEvent(String event)
```
    Event on which subscription is intended (if subscribing)
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of results to return. [default: 100] [minimum: 1] [maximum: 500]
  - setMaxResults
```
public Directory.Users.List setMaxResults(Integer maxResults)
```
    Maximum number of results to return.
  - getOrderBy
```
public String getOrderBy()
```
    Property to use for sorting results.
  - setOrderBy
```
public Directory.Users.List setOrderBy(String orderBy)
```
    Property to use for sorting results.
  - getPageToken
```
public String getPageToken()
```
    Token to specify next page in the list
  - setPageToken
```
public Directory.Users.List setPageToken(String pageToken)
```
    Token to specify next page in the list
  - getProjection
```
public String getProjection()
```
    What subset of fields to fetch for this user. [default: basic]
  - setProjection
```
public Directory.Users.List setProjection(String projection)
```
    What subset of fields to fetch for this user.
  - getQuery
```
public String getQuery()
```
    Query string for searching user fields. For more information on constructing user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search-users).
  - setQuery
```
public Directory.Users.List setQuery(String query)
```
    Query string for searching user fields. For more information on constructing user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search-users).
  - getShowDeleted
```
public String getShowDeleted()
```
    If set to `true`, retrieves the list of deleted users. (Default: `false`)
  - setShowDeleted
```
public Directory.Users.List setShowDeleted(String showDeleted)
```
    If set to `true`, retrieves the list of deleted users. (Default: `false`)
  - getSortOrder
```
public String getSortOrder()
```
    Whether to return results in ascending or descending order.
  - setSortOrder
```
public Directory.Users.List setSortOrder(String sortOrder)
```
    Whether to return results in ascending or descending order.
  - getViewType
```
public String getViewType()
```
    Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage- users#retrieve_users_non_admin). [default: admin_view]
  - setViewType
```
public Directory.Users.List setViewType(String viewType)
```
    Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides /manage-users#retrieve_users_non_admin).
  - set
```
public Directory.Users.List set(String parameterName,
                                Object value)
```
    Overrides:
    
    set in class DirectoryRequest<Users>

Class Directory.Users.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

getCustomFieldMask

setCustomFieldMask

getCustomer

setCustomer

getDomain

setDomain

getEvent

setEvent

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getProjection

setProjection

getQuery

setQuery

getShowDeleted

setShowDeleted

getSortOrder

setSortOrder

getViewType

setViewType

set