target.apidocs.com.google.api.services.directory.Directory.Users.Watch.html Maven / Gradle / Ivy
Directory.Users.Watch (Admin SDK API directory_v1-rev20220606-1.32.1)
com.google.api.services.directory
Class Directory.Users.Watch
- 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<Channel>
-
- com.google.api.services.directory.Directory.Users.Watch
-
- Enclosing class:
- Directory.Users
public class Directory.Users.Watch
extends DirectoryRequest<Channel>
-
-
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>
-
Field Summary
-
Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Watch(Channel content)
Watches for changes in users list.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getCustomer()
Immutable ID of the Google Workspace account.
String
getCustomFieldMask()
Comma-separated list of schema names.
String
getDomain()
Name of the domain.
String
getEvent()
Events to watch for.
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
getProjection()
What subset of fields to fetch for this user.
String
getQuery()
Query string search.
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.Watch
set(String parameterName,
Object value)
Directory.Users.Watch
set$Xgafv(String $Xgafv)
V1 error format.
Directory.Users.Watch
setAccessToken(String accessToken)
OAuth access token.
Directory.Users.Watch
setAlt(String alt)
Data format for response.
Directory.Users.Watch
setCallback(String callback)
JSONP
Directory.Users.Watch
setCustomer(String customer)
Immutable ID of the Google Workspace account.
Directory.Users.Watch
setCustomFieldMask(String customFieldMask)
Comma-separated list of schema names.
Directory.Users.Watch
setDomain(String domain)
Name of the domain.
Directory.Users.Watch
setEvent(String event)
Events to watch for.
Directory.Users.Watch
setFields(String fields)
Selector specifying which fields to include in a partial response.
Directory.Users.Watch
setKey(String key)
API key.
Directory.Users.Watch
setMaxResults(Integer maxResults)
Maximum number of results to return.
Directory.Users.Watch
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Directory.Users.Watch
setOrderBy(String orderBy)
Column to use for sorting results
Directory.Users.Watch
setPageToken(String pageToken)
Token to specify next page in the list
Directory.Users.Watch
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Directory.Users.Watch
setProjection(String projection)
What subset of fields to fetch for this user.
Directory.Users.Watch
setQuery(String query)
Query string search.
Directory.Users.Watch
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Directory.Users.Watch
setShowDeleted(String showDeleted)
If set to true, retrieves the list of deleted users.
Directory.Users.Watch
setSortOrder(String sortOrder)
Whether to return results in ascending or descending order.
Directory.Users.Watch
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Directory.Users.Watch
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Directory.Users.Watch
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.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
-
Watch
protected Watch(Channel content)
Watches for changes in users list.
Create a request for the method "users.watch".
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.
- Parameters:
content
- the Channel
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Directory.Users.Watch set$Xgafv(String $Xgafv)
Description copied from class: DirectoryRequest
V1 error format.
- Overrides:
set$Xgafv
in class DirectoryRequest<Channel>
-
setAccessToken
public Directory.Users.Watch setAccessToken(String accessToken)
Description copied from class: DirectoryRequest
OAuth access token.
- Overrides:
setAccessToken
in class DirectoryRequest<Channel>
-
setAlt
public Directory.Users.Watch setAlt(String alt)
Description copied from class: DirectoryRequest
Data format for response.
- Overrides:
setAlt
in class DirectoryRequest<Channel>
-
setCallback
public Directory.Users.Watch setCallback(String callback)
Description copied from class: DirectoryRequest
JSONP
- Overrides:
setCallback
in class DirectoryRequest<Channel>
-
setFields
public Directory.Users.Watch setFields(String fields)
Description copied from class: DirectoryRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class DirectoryRequest<Channel>
-
setKey
public Directory.Users.Watch 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<Channel>
-
setOauthToken
public Directory.Users.Watch setOauthToken(String oauthToken)
Description copied from class: DirectoryRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class DirectoryRequest<Channel>
-
setPrettyPrint
public Directory.Users.Watch setPrettyPrint(Boolean prettyPrint)
Description copied from class: DirectoryRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class DirectoryRequest<Channel>
-
setQuotaUser
public Directory.Users.Watch 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<Channel>
-
setUploadType
public Directory.Users.Watch setUploadType(String uploadType)
Description copied from class: DirectoryRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class DirectoryRequest<Channel>
-
setUploadProtocol
public Directory.Users.Watch setUploadProtocol(String uploadProtocol)
Description copied from class: DirectoryRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class DirectoryRequest<Channel>
-
getCustomFieldMask
public String getCustomFieldMask()
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.Watch setCustomFieldMask(String customFieldMask)
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()
Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a
customer, fill this field instead of domain.
-
setCustomer
public Directory.Users.Watch setCustomer(String customer)
Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users
for a customer, fill this field instead of domain.
-
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.Watch 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."
-
getEvent
public String getEvent()
Events to watch for.
-
setEvent
public Directory.Users.Watch setEvent(String event)
Events to watch for.
-
getMaxResults
public Integer getMaxResults()
Maximum number of results to return. [default: 100] [minimum: 1] [maximum: 500]
-
setMaxResults
public Directory.Users.Watch setMaxResults(Integer maxResults)
Maximum number of results to return.
-
getOrderBy
public String getOrderBy()
Column to use for sorting results
-
setOrderBy
public Directory.Users.Watch setOrderBy(String orderBy)
Column to use for sorting results
-
getPageToken
public String getPageToken()
Token to specify next page in the list
-
setPageToken
public Directory.Users.Watch 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.Watch setProjection(String projection)
What subset of fields to fetch for this user.
-
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-users
-
setQuery
public Directory.Users.Watch 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-users
-
getShowDeleted
public String getShowDeleted()
If set to true, retrieves the list of deleted users. (Default: false)
-
setShowDeleted
public Directory.Users.Watch 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.Watch 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.Watch 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.Watch set(String parameterName,
Object value)
- Overrides:
set
in class DirectoryRequest<Channel>
Copyright © 2011–2022 Google. All rights reserved.