Directory.Users.Get (Admin SDK API directory

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<User>
        
        com.google.api.services.directory.Directory.Users.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Directory.Users
```
public class Directory.Users.Get
extends DirectoryRequest<User>
```

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Get(String userKey)
Retrieves a user.

Constructors
Modifier	Constructor and Description
`protected`	`Get(String userKey)` Retrieves a user.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getCustomFieldMask()` A comma-separated list of schema names.
`String`	`getProjection()` What subset of fields to fetch for this user.
`String`	`getUserKey()` Identifies the user in the API request.
`String`	`getViewType()` Whether to fetch the administrator-only or domain-wide public view of the user.
`Directory.Users.Get`	`set(String parameterName, Object value)`
`Directory.Users.Get`	`set$Xgafv(String $Xgafv)` V1 error format.
`Directory.Users.Get`	`setAccessToken(String accessToken)` OAuth access token.
`Directory.Users.Get`	`setAlt(String alt)` Data format for response.
`Directory.Users.Get`	`setCallback(String callback)` JSONP
`Directory.Users.Get`	`setCustomFieldMask(String customFieldMask)` A comma-separated list of schema names.
`Directory.Users.Get`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Directory.Users.Get`	`setKey(String key)` API key.
`Directory.Users.Get`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Directory.Users.Get`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Directory.Users.Get`	`setProjection(String projection)` What subset of fields to fetch for this user.
`Directory.Users.Get`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Directory.Users.Get`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Directory.Users.Get`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Directory.Users.Get`	`setUserKey(String userKey)` Identifies the user in the API request.
`Directory.Users.Get`	`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.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
  - Get
```
protected Get(String userKey)
```
    Retrieves a user. Create a request for the method "users.get". 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:
    
    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.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<User>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<User>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Directory.Users.Get set$Xgafv(String $Xgafv)
```
    Description copied from class: DirectoryRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DirectoryRequest<User>
  - setAccessToken
```
public Directory.Users.Get setAccessToken(String accessToken)
```
    Description copied from class: DirectoryRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DirectoryRequest<User>
  - setAlt
```
public Directory.Users.Get setAlt(String alt)
```
    Description copied from class: DirectoryRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DirectoryRequest<User>
  - setCallback
```
public Directory.Users.Get setCallback(String callback)
```
    Description copied from class: DirectoryRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DirectoryRequest<User>
  - setFields
```
public Directory.Users.Get setFields(String fields)
```
    Description copied from class: DirectoryRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DirectoryRequest<User>
  - setKey
```
public Directory.Users.Get 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<User>
  - setOauthToken
```
public Directory.Users.Get setOauthToken(String oauthToken)
```
    Description copied from class: DirectoryRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DirectoryRequest<User>
  - setPrettyPrint
```
public Directory.Users.Get setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DirectoryRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DirectoryRequest<User>
  - setQuotaUser
```
public Directory.Users.Get 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<User>
  - setUploadType
```
public Directory.Users.Get setUploadType(String uploadType)
```
    Description copied from class: DirectoryRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DirectoryRequest<User>
  - setUploadProtocol
```
public Directory.Users.Get setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DirectoryRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DirectoryRequest<User>
  - getUserKey
```
public String getUserKey()
```
    Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
  - setUserKey
```
public Directory.Users.Get setUserKey(String 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.
  - getCustomFieldMask
```
public String getCustomFieldMask()
```
    A 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.Get setCustomFieldMask(String customFieldMask)
```
    A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.
  - getProjection
```
public String getProjection()
```
    What subset of fields to fetch for this user. [default: basic]
  - setProjection
```
public Directory.Users.Get setProjection(String projection)
```
    What subset of fields to fetch for this user.
  - 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.Get 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.Get set(String parameterName,
                               Object value)
```
    Overrides:
    
    set in class DirectoryRequest<User>

Class Directory.Users.Get

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.directory.DirectoryRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getUserKey

setUserKey

getCustomFieldMask

setCustomFieldMask

getProjection

setProjection

getViewType

setViewType

set