User (Admin Directory API directory_v1 (Rev. 11) 1.16.0-rc)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.admin.directory.model.User

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class User
extends GenericJson
```
JSON template for User object in Apps Directory API.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Admin Directory API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

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
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

Methods
Modifier and Type	Method and Description
`User`	`clone()`
`List<UserAddress>`	`getAddresses()` Addresses of User
`Boolean`	`getAgreedToTerms()` Indicates if user has agreed to terms (Read-only)
`List<String>`	`getAliases()` List of aliases (Read-only)
`Boolean`	`getChangePasswordAtNextLogin()` Boolean indicating if the user should change password in next login
`DateTime`	`getCreationTime()` User's Google account creation time.
`String`	`getCustomerId()` CustomerId of User (Read-only)
`DateTime`	`getDeletionTime()`
`List<UserEmail>`	`getEmails()` Emails of User
`List<UserExternalId>`	`getExternalIds()` The external Ids of User *
`String`	`getHashFunction()` Hash function name for password.
`String`	`getId()` Unique identifier of User (Read-only)
`List<UserIm>`	`getIms()` User's Instant Messenger
`Boolean`	`getIncludeInGlobalAddressList()` Boolean indicating if user is included in Global Address List
`Boolean`	`getIpWhitelisted()` Boolean indicating if ip is whitelisted
`Boolean`	`getIsAdmin()` Boolean indicating if the user is admin (Read-only)
`Boolean`	`getIsDelegatedAdmin()` Boolean indicating if the user is delegated admin (Read-only)
`Boolean`	`getIsMailboxSetup()` Is mailbox setup (Read-only)
`String`	`getKind()` Kind of resource this is.
`DateTime`	`getLastLoginTime()` User's last login time.
`UserName`	`getName()` User's name
`List<String>`	`getNonEditableAliases()` List of non editable aliases (Read-only)
`List<UserOrganization>`	`getOrganizations()` Organizations of User
`String`	`getOrgUnitPath()` OrgUnit of User
`String`	`getPassword()` User's password
`List<UserPhone>`	`getPhones()` Phone numbers of User
`String`	`getPrimaryEmail()` username of User
`List<UserRelation>`	`getRelations()` The Relations of User *
`Boolean`	`getSuspended()` Indicates if user is suspended
`String`	`getSuspensionReason()` Suspension reason if user is suspended (Read-only)
`String`	`getThumbnailPhotoUrl()` Photo Url of the user (Read-only)
`User`	`set(String fieldName, Object value)`
`User`	`setAddresses(List<UserAddress> addresses)` Addresses of User
`User`	`setAgreedToTerms(Boolean agreedToTerms)` Indicates if user has agreed to terms (Read-only)
`User`	`setAliases(List<String> aliases)` List of aliases (Read-only)
`User`	`setChangePasswordAtNextLogin(Boolean changePasswordAtNextLogin)` Boolean indicating if the user should change password in next login
`User`	`setCreationTime(DateTime creationTime)` User's Google account creation time.
`User`	`setCustomerId(String customerId)` CustomerId of User (Read-only)
`User`	`setDeletionTime(DateTime deletionTime)`
`User`	`setEmails(List<UserEmail> emails)` Emails of User
`User`	`setExternalIds(List<UserExternalId> externalIds)` The external Ids of User *
`User`	`setHashFunction(String hashFunction)` Hash function name for password.
`User`	`setId(String id)` Unique identifier of User (Read-only)
`User`	`setIms(List<UserIm> ims)` User's Instant Messenger
`User`	`setIncludeInGlobalAddressList(Boolean includeInGlobalAddressList)` Boolean indicating if user is included in Global Address List
`User`	`setIpWhitelisted(Boolean ipWhitelisted)` Boolean indicating if ip is whitelisted
`User`	`setIsAdmin(Boolean isAdmin)` Boolean indicating if the user is admin (Read-only)
`User`	`setIsDelegatedAdmin(Boolean isDelegatedAdmin)` Boolean indicating if the user is delegated admin (Read-only)
`User`	`setIsMailboxSetup(Boolean isMailboxSetup)` Is mailbox setup (Read-only)
`User`	`setKind(String kind)` Kind of resource this is.
`User`	`setLastLoginTime(DateTime lastLoginTime)` User's last login time.
`User`	`setName(UserName name)` User's name
`User`	`setNonEditableAliases(List<String> nonEditableAliases)` List of non editable aliases (Read-only)
`User`	`setOrganizations(List<UserOrganization> organizations)` Organizations of User
`User`	`setOrgUnitPath(String orgUnitPath)` OrgUnit of User
`User`	`setPassword(String password)` User's password
`User`	`setPhones(List<UserPhone> phones)` Phone numbers of User
`User`	`setPrimaryEmail(String primaryEmail)` username of User
`User`	`setRelations(List<UserRelation> relations)` The Relations of User *
`User`	`setSuspended(Boolean suspended)` Indicates if user is suspended
`User`	`setSuspensionReason(String suspensionReason)` Suspension reason if user is suspended (Read-only)
`User`	`setThumbnailPhotoUrl(String thumbnailPhotoUrl)` Photo Url of the user (Read-only)

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - getAddresses
```
public List<UserAddress> getAddresses()
```
    Addresses of User
    
    Returns:
    value or null for none
  - setAddresses
```
public User setAddresses(List<UserAddress> addresses)
```
    Addresses of User
    
    Parameters:
    addresses - addresses or null for none
  - getAgreedToTerms
```
public Boolean getAgreedToTerms()
```
    Indicates if user has agreed to terms (Read-only)
    
    Returns:
    value or null for none
  - setAgreedToTerms
```
public User setAgreedToTerms(Boolean agreedToTerms)
```
    Indicates if user has agreed to terms (Read-only)
    
    Parameters:
    agreedToTerms - agreedToTerms or null for none
  - getAliases
```
public List<String> getAliases()
```
    List of aliases (Read-only)
    
    Returns:
    value or null for none
  - setAliases
```
public User setAliases(List<String> aliases)
```
    List of aliases (Read-only)
    
    Parameters:
    aliases - aliases or null for none
  - getChangePasswordAtNextLogin
```
public Boolean getChangePasswordAtNextLogin()
```
    Boolean indicating if the user should change password in next login
    
    Returns:
    value or null for none
  - setChangePasswordAtNextLogin
```
public User setChangePasswordAtNextLogin(Boolean changePasswordAtNextLogin)
```
    Boolean indicating if the user should change password in next login
    
    Parameters:
    changePasswordAtNextLogin - changePasswordAtNextLogin or null for none
  - getCreationTime
```
public DateTime getCreationTime()
```
    User's Google account creation time. (Read-only)
    
    Returns:
    value or null for none
  - setCreationTime
```
public User setCreationTime(DateTime creationTime)
```
    User's Google account creation time. (Read-only)
    
    Parameters:
    creationTime - creationTime or null for none
  - getCustomerId
```
public String getCustomerId()
```
    CustomerId of User (Read-only)
    
    Returns:
    value or null for none
  - setCustomerId
```
public User setCustomerId(String customerId)
```
    CustomerId of User (Read-only)
    
    Parameters:
    customerId - customerId or null for none
  - getDeletionTime
```
public DateTime getDeletionTime()
```
    Returns:
    value or null for none
  - setDeletionTime
```
public User setDeletionTime(DateTime deletionTime)
```
    Parameters:
    deletionTime - deletionTime or null for none
  - getEmails
```
public List<UserEmail> getEmails()
```
    Emails of User
    
    Returns:
    value or null for none
  - setEmails
```
public User setEmails(List<UserEmail> emails)
```
    Emails of User
    
    Parameters:
    emails - emails or null for none
  - getExternalIds
```
public List<UserExternalId> getExternalIds()
```
    The external Ids of User *
    
    Returns:
    value or null for none
  - setExternalIds
```
public User setExternalIds(List<UserExternalId> externalIds)
```
    The external Ids of User *
    
    Parameters:
    externalIds - externalIds or null for none
  - getHashFunction
```
public String getHashFunction()
```
    Hash function name for password. Supported are MD5, SHA-1 and crypt
    
    Returns:
    value or null for none
  - setHashFunction
```
public User setHashFunction(String hashFunction)
```
    Hash function name for password. Supported are MD5, SHA-1 and crypt
    
    Parameters:
    hashFunction - hashFunction or null for none
  - getId
```
public String getId()
```
    Unique identifier of User (Read-only)
    
    Returns:
    value or null for none
  - setId
```
public User setId(String id)
```
    Unique identifier of User (Read-only)
    
    Parameters:
    id - id or null for none
  - getIms
```
public List<UserIm> getIms()
```
    User's Instant Messenger
    
    Returns:
    value or null for none
  - setIms
```
public User setIms(List<UserIm> ims)
```
    User's Instant Messenger
    
    Parameters:
    ims - ims or null for none
  - getIncludeInGlobalAddressList
```
public Boolean getIncludeInGlobalAddressList()
```
    Boolean indicating if user is included in Global Address List
    
    Returns:
    value or null for none
  - setIncludeInGlobalAddressList
```
public User setIncludeInGlobalAddressList(Boolean includeInGlobalAddressList)
```
    Boolean indicating if user is included in Global Address List
    
    Parameters:
    includeInGlobalAddressList - includeInGlobalAddressList or null for none
  - getIpWhitelisted
```
public Boolean getIpWhitelisted()
```
    Boolean indicating if ip is whitelisted
    
    Returns:
    value or null for none
  - setIpWhitelisted
```
public User setIpWhitelisted(Boolean ipWhitelisted)
```
    Boolean indicating if ip is whitelisted
    
    Parameters:
    ipWhitelisted - ipWhitelisted or null for none
  - getIsAdmin
```
public Boolean getIsAdmin()
```
    Boolean indicating if the user is admin (Read-only)
    
    Returns:
    value or null for none
  - setIsAdmin
```
public User setIsAdmin(Boolean isAdmin)
```
    Boolean indicating if the user is admin (Read-only)
    
    Parameters:
    isAdmin - isAdmin or null for none
  - getIsDelegatedAdmin
```
public Boolean getIsDelegatedAdmin()
```
    Boolean indicating if the user is delegated admin (Read-only)
    
    Returns:
    value or null for none
  - setIsDelegatedAdmin
```
public User setIsDelegatedAdmin(Boolean isDelegatedAdmin)
```
    Boolean indicating if the user is delegated admin (Read-only)
    
    Parameters:
    isDelegatedAdmin - isDelegatedAdmin or null for none
  - getIsMailboxSetup
```
public Boolean getIsMailboxSetup()
```
    Is mailbox setup (Read-only)
    
    Returns:
    value or null for none
  - setIsMailboxSetup
```
public User setIsMailboxSetup(Boolean isMailboxSetup)
```
    Is mailbox setup (Read-only)
    
    Parameters:
    isMailboxSetup - isMailboxSetup or null for none
  - getKind
```
public String getKind()
```
    Kind of resource this is.
    
    Returns:
    value or null for none
  - setKind
```
public User setKind(String kind)
```
    Kind of resource this is.
    
    Parameters:
    kind - kind or null for none
  - getLastLoginTime
```
public DateTime getLastLoginTime()
```
    User's last login time. (Read-only)
    
    Returns:
    value or null for none
  - setLastLoginTime
```
public User setLastLoginTime(DateTime lastLoginTime)
```
    User's last login time. (Read-only)
    
    Parameters:
    lastLoginTime - lastLoginTime or null for none
  - getName
```
public UserName getName()
```
    User's name
    
    Returns:
    value or null for none
  - setName
```
public User setName(UserName name)
```
    User's name
    
    Parameters:
    name - name or null for none
  - getNonEditableAliases
```
public List<String> getNonEditableAliases()
```
    List of non editable aliases (Read-only)
    
    Returns:
    value or null for none
  - setNonEditableAliases
```
public User setNonEditableAliases(List<String> nonEditableAliases)
```
    List of non editable aliases (Read-only)
    
    Parameters:
    nonEditableAliases - nonEditableAliases or null for none
  - getOrgUnitPath
```
public String getOrgUnitPath()
```
    OrgUnit of User
    
    Returns:
    value or null for none
  - setOrgUnitPath
```
public User setOrgUnitPath(String orgUnitPath)
```
    OrgUnit of User
    
    Parameters:
    orgUnitPath - orgUnitPath or null for none
  - getOrganizations
```
public List<UserOrganization> getOrganizations()
```
    Organizations of User
    
    Returns:
    value or null for none
  - setOrganizations
```
public User setOrganizations(List<UserOrganization> organizations)
```
    Organizations of User
    
    Parameters:
    organizations - organizations or null for none
  - getPassword
```
public String getPassword()
```
    User's password
    
    Returns:
    value or null for none
  - setPassword
```
public User setPassword(String password)
```
    User's password
    
    Parameters:
    password - password or null for none
  - getPhones
```
public List<UserPhone> getPhones()
```
    Phone numbers of User
    
    Returns:
    value or null for none
  - setPhones
```
public User setPhones(List<UserPhone> phones)
```
    Phone numbers of User
    
    Parameters:
    phones - phones or null for none
  - getPrimaryEmail
```
public String getPrimaryEmail()
```
    username of User
    
    Returns:
    value or null for none
  - setPrimaryEmail
```
public User setPrimaryEmail(String primaryEmail)
```
    username of User
    
    Parameters:
    primaryEmail - primaryEmail or null for none
  - getRelations
```
public List<UserRelation> getRelations()
```
    The Relations of User *
    
    Returns:
    value or null for none
  - setRelations
```
public User setRelations(List<UserRelation> relations)
```
    The Relations of User *
    
    Parameters:
    relations - relations or null for none
  - getSuspended
```
public Boolean getSuspended()
```
    Indicates if user is suspended
    
    Returns:
    value or null for none
  - setSuspended
```
public User setSuspended(Boolean suspended)
```
    Indicates if user is suspended
    
    Parameters:
    suspended - suspended or null for none
  - getSuspensionReason
```
public String getSuspensionReason()
```
    Suspension reason if user is suspended (Read-only)
    
    Returns:
    value or null for none
  - setSuspensionReason
```
public User setSuspensionReason(String suspensionReason)
```
    Suspension reason if user is suspended (Read-only)
    
    Parameters:
    suspensionReason - suspensionReason or null for none
  - getThumbnailPhotoUrl
```
public String getThumbnailPhotoUrl()
```
    Photo Url of the user (Read-only)
    
    Returns:
    value or null for none
  - setThumbnailPhotoUrl
```
public User setThumbnailPhotoUrl(String thumbnailPhotoUrl)
```
    Photo Url of the user (Read-only)
    
    Parameters:
    thumbnailPhotoUrl - thumbnailPhotoUrl or null for none
  - set
```
public User set(String fieldName,
       Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public User clone()
```
    Overrides:
    
    clone in class GenericJson

Admin Directory API directory_v1 (revision 11)

Class User

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

getAddresses

setAddresses

getAgreedToTerms

setAgreedToTerms

getAliases

setAliases

getChangePasswordAtNextLogin

setChangePasswordAtNextLogin

getCreationTime

setCreationTime

getCustomerId

setCustomerId

getDeletionTime

setDeletionTime

getEmails

setEmails

getExternalIds

setExternalIds

getHashFunction

setHashFunction

getId

setId

getIms

setIms

getIncludeInGlobalAddressList

setIncludeInGlobalAddressList

getIpWhitelisted

setIpWhitelisted

getIsAdmin

setIsAdmin

getIsDelegatedAdmin

setIsDelegatedAdmin

getIsMailboxSetup

setIsMailboxSetup

getKind

setKind

getLastLoginTime

setLastLoginTime

getName

setName

getNonEditableAliases

setNonEditableAliases

getOrgUnitPath

setOrgUnitPath

getOrganizations

setOrganizations

getPassword

setPassword

getPhones

setPhones

getPrimaryEmail

setPrimaryEmail

getRelations

setRelations

getSuspended

setSuspended

getSuspensionReason

setSuspensionReason

getThumbnailPhotoUrl

setThumbnailPhotoUrl

set

clone