com.google.api.services.admin.directory

Class Directory.Users.List

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.admin.directory.DirectoryRequest<Users>

com.google.api.services.admin.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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Directory.Users.List() Retrieve either deleted users or all users in a domain (paginated) Create a request for the method "users.list".

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getCustomer() Immutable id of the Google Apps account.
String	getDomain() Name of the domain.
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 for prefix matching searches.
String	getShowDeleted() If set to true retrieves the list of deleted users.
String	getSortOrder() Whether to return results in ascending or descending order.
Directory.Users.List	set(String parameterName, Object value)
Directory.Users.List	setAlt(String alt) Data format for the response.
Directory.Users.List	setCustomer(String customer) Immutable id of the Google Apps account.
Directory.Users.List	setDomain(String domain) Name of the domain.
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) Column 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	setQuery(String query) Query string for prefix matching searches.
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	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.admin.directory.DirectoryRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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

Directory.Users.List

protected Directory.Users.List()

Retrieve either deleted users or all users in a domain (paginated) 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

setAlt

public Directory.Users.List setAlt(String alt)

Description copied from class: DirectoryRequest

Data format for the response.

Overrides:

setAlt 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 userIp if both are provided.

Overrides:

setQuotaUser in class DirectoryRequest<Users>

setUserIp

public Directory.Users.List setUserIp(String userIp)

Description copied from class: DirectoryRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DirectoryRequest<Users>

getCustomer

public String getCustomer()

Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.

setCustomer

public Directory.Users.List setCustomer(String customer)

Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.

getOrderBy

public String getOrderBy()

Column to use for sorting results

setOrderBy

public Directory.Users.List setOrderBy(String orderBy)

Column to use for sorting results

getDomain

public String getDomain()

Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.

setDomain

public Directory.Users.List setDomain(String domain)

Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.

getShowDeleted

public String getShowDeleted()

If set to true retrieves the list of deleted users. Default is false

setShowDeleted

public Directory.Users.List setShowDeleted(String showDeleted)

If set to true retrieves the list of deleted users. Default is false

getMaxResults

public Integer getMaxResults()

Maximum number of results to return. Default is 100. Max allowed is 500 [minimum: 1] [maximum: 500]

setMaxResults

public Directory.Users.List setMaxResults(Integer maxResults)

Maximum number of results to return. Default is 100. Max allowed is 500

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

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.

getQuery

public String getQuery()

Query string for prefix matching searches. Should be of the form "key:value*" where key can be "email", "givenName" or "familyName". The asterisk is required, for example: "givenName:Ann*" is a valid query.

setQuery

public Directory.Users.List setQuery(String query)

Query string for prefix matching searches. Should be of the form "key:value*" where key can be "email", "givenName" or "familyName". The asterisk is required, for example: "givenName:Ann*" is a valid query.

set

public Directory.Users.List set(String parameterName,
                       Object value)

Overrides:

set in class DirectoryRequest<Users>