Show / Hide Table of Contents

Class UsersResource.GetRequest

Retrieves a user.

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

Constructors

GetRequest(IClientService, String)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string userKey)
Parameters
Type Name Description
IClientService service
System.String userKey

Properties

CustomFieldMask

A 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
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.User>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.User>.MethodName

Projection

What subset of fields to fetch for this user.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.User>.RestPath

UserKey

Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.

Declaration
[RequestParameter("userKey", RequestParameterType.Path)]
public virtual string UserKey { get; }
Property Value
Type Description
System.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).

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

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.User>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
Back to top