public class Directory.Users.List extends DirectoryRequest<Users>
com.google.api.client.util.GenericData.Flags
Modifier | Constructor and Description |
---|---|
protected |
List()
Retrieve either deleted users or all users in a domain (paginated)
Create a request for the method "users.list".
|
Modifier and Type | Method and Description |
---|---|
com.google.api.client.http.HttpRequest |
buildHttpRequestUsingHead() |
com.google.api.client.http.HttpResponse |
executeUsingHead() |
java.lang.String |
getCustomer()
Immutable ID of the G Suite account.
|
java.lang.String |
getCustomFieldMask()
Comma-separated list of schema names.
|
java.lang.String |
getDomain()
Name of the domain.
|
java.lang.String |
getEvent()
Event on which subscription is intended (if subscribing)
|
java.lang.Integer |
getMaxResults()
Maximum number of results to return.
|
java.lang.String |
getOrderBy()
Column to use for sorting results
|
java.lang.String |
getPageToken()
Token to specify next page in the list
|
java.lang.String |
getProjection()
What subset of fields to fetch for this user.
|
java.lang.String |
getQuery()
Query string search.
|
java.lang.String |
getShowDeleted()
If set to true, retrieves the list of deleted users.
|
java.lang.String |
getSortOrder()
Whether to return results in ascending or descending order.
|
java.lang.String |
getViewType()
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
|
Directory.Users.List |
set(java.lang.String parameterName,
java.lang.Object value) |
Directory.Users.List |
setAlt(java.lang.String alt)
Data format for the response.
|
Directory.Users.List |
setCustomer(java.lang.String customer)
Immutable ID of the G Suite account.
|
Directory.Users.List |
setCustomFieldMask(java.lang.String customFieldMask)
Comma-separated list of schema names.
|
Directory.Users.List |
setDomain(java.lang.String domain)
Name of the domain.
|
Directory.Users.List |
setEvent(java.lang.String event)
Event on which subscription is intended (if subscribing)
|
Directory.Users.List |
setFields(java.lang.String fields)
Selector specifying which fields to include in a partial response.
|
Directory.Users.List |
setKey(java.lang.String key)
API key.
|
Directory.Users.List |
setMaxResults(java.lang.Integer maxResults)
Maximum number of results to return.
|
Directory.Users.List |
setOauthToken(java.lang.String oauthToken)
OAuth 2.0 token for the current user.
|
Directory.Users.List |
setOrderBy(java.lang.String orderBy)
Column to use for sorting results
|
Directory.Users.List |
setPageToken(java.lang.String pageToken)
Token to specify next page in the list
|
Directory.Users.List |
setPrettyPrint(java.lang.Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Directory.Users.List |
setProjection(java.lang.String projection)
What subset of fields to fetch for this user.
|
Directory.Users.List |
setQuery(java.lang.String query)
Query string search.
|
Directory.Users.List |
setQuotaUser(java.lang.String quotaUser)
An opaque string that represents a user for quota purposes.
|
Directory.Users.List |
setShowDeleted(java.lang.String showDeleted)
If set to true, retrieves the list of deleted users.
|
Directory.Users.List |
setSortOrder(java.lang.String sortOrder)
Whether to return results in ascending or descending order.
|
Directory.Users.List |
setUserIp(java.lang.String userIp)
Deprecated.
|
Directory.Users.List |
setViewType(java.lang.String viewType)
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders
getJsonContent, newExceptionOnError, queue
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
protected List()
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.
public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Users>
java.io.IOException
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Users>
java.io.IOException
public Directory.Users.List setAlt(java.lang.String alt)
DirectoryRequest
setAlt
in class DirectoryRequest<Users>
public Directory.Users.List setFields(java.lang.String fields)
DirectoryRequest
setFields
in class DirectoryRequest<Users>
public Directory.Users.List setKey(java.lang.String key)
DirectoryRequest
setKey
in class DirectoryRequest<Users>
public Directory.Users.List setOauthToken(java.lang.String oauthToken)
DirectoryRequest
setOauthToken
in class DirectoryRequest<Users>
public Directory.Users.List setPrettyPrint(java.lang.Boolean prettyPrint)
DirectoryRequest
setPrettyPrint
in class DirectoryRequest<Users>
public Directory.Users.List setQuotaUser(java.lang.String quotaUser)
DirectoryRequest
setQuotaUser
in class DirectoryRequest<Users>
public Directory.Users.List setUserIp(java.lang.String userIp)
DirectoryRequest
setUserIp
in class DirectoryRequest<Users>
public java.lang.String getCustomFieldMask()
public Directory.Users.List setCustomFieldMask(java.lang.String customFieldMask)
public java.lang.String getCustomer()
public Directory.Users.List setCustomer(java.lang.String customer)
public java.lang.String getDomain()
public Directory.Users.List setDomain(java.lang.String domain)
public java.lang.String getEvent()
public Directory.Users.List setEvent(java.lang.String event)
public java.lang.Integer getMaxResults()
public Directory.Users.List setMaxResults(java.lang.Integer maxResults)
public java.lang.String getOrderBy()
public Directory.Users.List setOrderBy(java.lang.String orderBy)
public java.lang.String getPageToken()
public Directory.Users.List setPageToken(java.lang.String pageToken)
public java.lang.String getProjection()
public Directory.Users.List setProjection(java.lang.String projection)
public java.lang.String getQuery()
public Directory.Users.List setQuery(java.lang.String query)
public java.lang.String getShowDeleted()
public Directory.Users.List setShowDeleted(java.lang.String showDeleted)
public java.lang.String getSortOrder()
public Directory.Users.List setSortOrder(java.lang.String sortOrder)
public java.lang.String getViewType()
public Directory.Users.List setViewType(java.lang.String viewType)
public Directory.Users.List set(java.lang.String parameterName, java.lang.Object value)
set
in class DirectoryRequest<Users>