Show / Hide Table of Contents

Class UsersResource.WatchRequest

Watches for changes in users list.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Channel>
DirectoryBaseServiceRequest<Channel>
UsersResource.WatchRequest
Implements
IClientServiceRequest<Channel>
IClientServiceRequest
Inherited Members
DirectoryBaseServiceRequest<Channel>.Xgafv
DirectoryBaseServiceRequest<Channel>.AccessToken
DirectoryBaseServiceRequest<Channel>.Alt
DirectoryBaseServiceRequest<Channel>.Callback
DirectoryBaseServiceRequest<Channel>.Fields
DirectoryBaseServiceRequest<Channel>.Key
DirectoryBaseServiceRequest<Channel>.OauthToken
DirectoryBaseServiceRequest<Channel>.PrettyPrint
DirectoryBaseServiceRequest<Channel>.QuotaUser
DirectoryBaseServiceRequest<Channel>.UploadType
DirectoryBaseServiceRequest<Channel>.UploadProtocol
ClientServiceRequest<Channel>.Execute()
ClientServiceRequest<Channel>.ExecuteAsStream()
ClientServiceRequest<Channel>.ExecuteAsync()
ClientServiceRequest<Channel>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Channel>.ExecuteAsStreamAsync()
ClientServiceRequest<Channel>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Channel>.CreateRequest(bool?)
ClientServiceRequest<Channel>.GenerateRequestUri()
ClientServiceRequest<Channel>.GetDefaultETagAction(string)
ClientServiceRequest<Channel>.ETagAction
ClientServiceRequest<Channel>.ModifyRequest
ClientServiceRequest<Channel>.ValidateParameters
ClientServiceRequest<Channel>.ApiVersion
ClientServiceRequest<Channel>.RequestParameters
ClientServiceRequest<Channel>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Admin.Directory.directory_v1
Assembly: Google.Apis.Admin.Directory.directory_v1.dll
Syntax
public class UsersResource.WatchRequest : DirectoryBaseServiceRequest<Channel>, IClientServiceRequest<Channel>, IClientServiceRequest

Constructors

WatchRequest(IClientService, Channel)

Constructs a new Watch request.

Declaration
public WatchRequest(IClientService service, Channel body)
Parameters
Type Name Description
IClientService service
Channel body

Properties

CustomFieldMask

Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.

Declaration
[RequestParameter("customFieldMask", RequestParameterType.Query)]
public virtual string CustomFieldMask { get; set; }
Property Value
Type Description
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.

Declaration
[RequestParameter("customer", RequestParameterType.Query)]
public virtual string Customer { get; set; }
Property Value
Type Description
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."

Declaration
[RequestParameter("domain", RequestParameterType.Query)]
public virtual string Domain { get; set; }
Property Value
Type Description
string

Event

Events to watch for.

Declaration
[RequestParameter("event", RequestParameterType.Query)]
public virtual UsersResource.WatchRequest.EventEnum? Event { get; set; }
Property Value
Type Description
UsersResource.WatchRequest.EventEnum?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Channel>.HttpMethod

MaxResults

Maximum number of results to return.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Channel>.MethodName

OrderBy

Column to use for sorting results

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual UsersResource.WatchRequest.OrderByEnum? OrderBy { get; set; }
Property Value
Type Description
UsersResource.WatchRequest.OrderByEnum?

PageToken

Token to specify next page in the list

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Projection

What subset of fields to fetch for this user.

Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual UsersResource.WatchRequest.ProjectionEnum? Projection { get; set; }
Property Value
Type Description
UsersResource.WatchRequest.ProjectionEnum?

Query

Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Channel>.RestPath

ShowDeleted

If set to true, retrieves the list of deleted users. (Default: false)

Declaration
[RequestParameter("showDeleted", RequestParameterType.Query)]
public virtual string ShowDeleted { get; set; }
Property Value
Type Description
string

SortOrder

Whether to return results in ascending or descending order.

Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual UsersResource.WatchRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
UsersResource.WatchRequest.SortOrderEnum?

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.

Declaration
[RequestParameter("viewType", RequestParameterType.Query)]
public virtual UsersResource.WatchRequest.ViewTypeEnum? ViewType { get; set; }
Property Value
Type Description
UsersResource.WatchRequest.ViewTypeEnum?

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
ClientServiceRequest<Channel>.GetBody()

InitParameters()

Initializes Watch parameter list.

Declaration
protected override void InitParameters()
Overrides
DirectoryBaseServiceRequest<Channel>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX