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

com.google.api.services.admin.directory.Directory.Users.Watch

All Implemented Interfaces:

Cloneable, Map<String,Object>

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>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Directory.Users.Watch(Channel content) Watch for changes in users list Create a request for the method "users.watch".

Method Summary

Methods

Modifier and Type	Method and Description
String	getCustomer() Immutable id of the Google Apps account.
String	getDomain() Name of the domain.
String	getEvent() Event on which subscription is intended (if subscribing)
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	getShowDeleted() If set to true retrieves the list of deleted users.
String	getSortOrder() Whether to return results in ascending or descending order.
Directory.Users.Watch	set(String parameterName, Object value)
Directory.Users.Watch	setAlt(String alt) Data format for the response.
Directory.Users.Watch	setCustomer(String customer) Immutable id of the Google Apps account.
Directory.Users.Watch	setDomain(String domain) Name of the domain.
Directory.Users.Watch	setEvent(String event) Event on which subscription is intended (if subscribing)
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	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	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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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.Watch

protected Directory.Users.Watch(Channel content)

Watch 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

setAlt

public Directory.Users.Watch setAlt(String alt)

Description copied from class: DirectoryRequest

Data format for the response.

Overrides:

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

Overrides:

setQuotaUser in class DirectoryRequest<Channel>

setUserIp

public Directory.Users.Watch 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<Channel>

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.Watch 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.Watch 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.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.

getShowDeleted

public String getShowDeleted()

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

setShowDeleted

public Directory.Users.Watch 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.Watch 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.Watch 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.Watch setSortOrder(String sortOrder)

Whether to return results in ascending or descending order.

getQuery

public String getQuery()

Query string search. Should be of the form "" where field can be any of supported fields, operators can be one of '=' for exact match or ':' for prefix match. For prefix match, the value should always be followed by a *.

setQuery

public Directory.Users.Watch setQuery(String query)

Query string search. Should be of the form "" where field can be any of supported fields, operators can be one of '=' for exact match or ':' for prefix match. For prefix match, the value should always be followed by a *.

getEvent

public String getEvent()

Event on which subscription is intended (if subscribing)

setEvent

public Directory.Users.Watch setEvent(String event)

Event on which subscription is intended (if subscribing)

set

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

Overrides:

set in class DirectoryRequest<Channel>