com.google.api.services.directory.model.User Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.directory.model;
/**
* The Directory API allows you to create and manage your account's users, user aliases, and user
* Gmail chat profile photos. For more information about common tasks, see the [User Accounts
* Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases
* Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
*
* 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 SDK API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class User extends com.google.api.client.json.GenericJson {
/**
* A list of the user's addresses. The maximum allowed data size for this field is 10Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object addresses;
/**
* Output only. This property is `true` if the user has completed an initial login and accepted
* the Terms of Service agreement.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean agreedToTerms;
/**
* Output only. A list of the user's alias email addresses.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List aliases;
/**
* Indicates if user is archived.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean archived;
/**
* Indicates if the user is forced to change their password at next login. This setting doesn't
* apply when [the user signs in via a third-party identity
* provider](https://support.google.com/a/answer/60224).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean changePasswordAtNextLogin;
/**
* User's G Suite account creation time. (Read-only)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private com.google.api.client.util.DateTime creationTime;
/**
* Custom fields of the user. The key is a `schema_name` and its values are `'field_name':
* 'field_value'`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map> customSchemas;
/**
* Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides
* /manage-users.html#get_all_users). You can use the alias `my_customer` to represent your
* account's `customerId`. As a reseller administrator, you can use the resold customer account's
* `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter
* of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String customerId;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private com.google.api.client.util.DateTime deletionTime;
/**
* A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object emails;
/**
* Output only. ETag of the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String etag;
/**
* A list of external IDs for the user, such as an employee or network ID. The maximum allowed
* data size for this field is 2Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object externalIds;
/**
* The user's gender. The maximum allowed data size for this field is 1Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object gender;
/**
* Stores the hash format of the `password` property. The following `hashFunction` values are
* allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA1` - Accepts simple hex-encoded
* values. * `crypt` - Compliant with the [C crypt
* library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix
* `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds
* are specified as part of the prefix, they must be 10,000 or fewer.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String hashFunction;
/**
* The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String id;
/**
* The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties.
* But, only one of these ims properties can be the primary IM contact. The maximum allowed data
* size for this field is 2Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object ims;
/**
* Indicates if the user's profile is visible in the Google Workspace global address list when the
* contact sharing feature is enabled for the domain. For more information about excluding user
* profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean includeInGlobalAddressList;
/**
* If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean ipWhitelisted;
/**
* Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can
* only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-
* users.html#make_admin) operation ( [makeAdmin](/admin-
* sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert
* ](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-
* sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean isAdmin;
/**
* Output only. Indicates if the user is a delegated administrator. Delegated administrators are
* supported by the API but cannot create or undelete users, or make users administrators. These
* requests are ignored by the API service. Roles and privileges for administrators are assigned
* using the [Admin console](https://support.google.com/a/answer/33325).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean isDelegatedAdmin;
/**
* Output only. Is 2-step verification enforced (Read-only)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean isEnforcedIn2Sv;
/**
* Output only. Is enrolled in 2-step verification (Read-only)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean isEnrolledIn2Sv;
/**
* Output only. Indicates if the user's Google mailbox is created. This property is only
* applicable if the user has been assigned a Gmail license.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean isMailboxSetup;
/**
* The user's keywords. The maximum allowed data size for this field is 1Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object keywords;
/**
* Output only. The type of the API resource. For Users resources, the value is
* `admin#directory#user`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* The user's languages. The maximum allowed data size for this field is 1Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object languages;
/**
* User's last login time. (Read-only)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private com.google.api.client.util.DateTime lastLoginTime;
/**
* The user's locations. The maximum allowed data size for this field is 10Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object locations;
/**
* Holds the given and family names of the user, and the read-only `fullName` value. The maximum
* number of characters in the `givenName` and in the `familyName` values is 60. In addition, name
* values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9),
* dashes (-), forward slashes (/), and periods (.). For more information about character usage
* rules, see the [administration help center](https://support.google.com/a/answer/9193374).
* Maximum allowed data size for this field is 1Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private UserName name;
/**
* Output only. List of the user's non-editable alias email addresses. These are typically outside
* the account's primary domain or sub-domain.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List nonEditableAliases;
/**
* Notes for the user.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object notes;
/**
* The full path of the parent organization associated with the user. If the parent organization
* is the top-level, it is represented as a forward slash (`/`).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String orgUnitPath;
/**
* A list of organizations the user belongs to. The maximum allowed data size for this field is
* 10Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object organizations;
/**
* User's password
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String password;
/**
* A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object phones;
/**
* A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information
* for the user.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object posixAccounts;
/**
* The user's primary email address. This property is required in a request to create a user
* account. The `primaryEmail` must be unique and cannot be an alias of another user.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String primaryEmail;
/**
* Recovery email of the user.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String recoveryEmail;
/**
* Recovery phone of the user. The phone number must be in the E.164 format, starting with the
* plus sign (+). Example: *+16506661212*.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String recoveryPhone;
/**
* A list of the user's relationships to other users. The maximum allowed data size for this field
* is 2Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object relations;
/**
* A list of SSH public keys.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object sshPublicKeys;
/**
* Indicates if user is suspended.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean suspended;
/**
* Output only. Has the reason a user account is suspended either by the administrator or by
* Google at the time of suspension. The property is returned only if the `suspended` property is
* `true`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String suspensionReason;
/**
* Output only. ETag of the user's photo (Read-only)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String thumbnailPhotoEtag;
/**
* Output only. Photo Url of the user (Read-only)
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String thumbnailPhotoUrl;
/**
* The user's websites. The maximum allowed data size for this field is 2Kb.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Object websites;
/**
* A list of the user's addresses. The maximum allowed data size for this field is 10Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getAddresses() {
return addresses;
}
/**
* A list of the user's addresses. The maximum allowed data size for this field is 10Kb.
* @param addresses addresses or {@code null} for none
*/
public User setAddresses(java.lang.Object addresses) {
this.addresses = addresses;
return this;
}
/**
* Output only. This property is `true` if the user has completed an initial login and accepted
* the Terms of Service agreement.
* @return value or {@code null} for none
*/
public java.lang.Boolean getAgreedToTerms() {
return agreedToTerms;
}
/**
* Output only. This property is `true` if the user has completed an initial login and accepted
* the Terms of Service agreement.
* @param agreedToTerms agreedToTerms or {@code null} for none
*/
public User setAgreedToTerms(java.lang.Boolean agreedToTerms) {
this.agreedToTerms = agreedToTerms;
return this;
}
/**
* Output only. A list of the user's alias email addresses.
* @return value or {@code null} for none
*/
public java.util.List getAliases() {
return aliases;
}
/**
* Output only. A list of the user's alias email addresses.
* @param aliases aliases or {@code null} for none
*/
public User setAliases(java.util.List aliases) {
this.aliases = aliases;
return this;
}
/**
* Indicates if user is archived.
* @return value or {@code null} for none
*/
public java.lang.Boolean getArchived() {
return archived;
}
/**
* Indicates if user is archived.
* @param archived archived or {@code null} for none
*/
public User setArchived(java.lang.Boolean archived) {
this.archived = archived;
return this;
}
/**
* Indicates if the user is forced to change their password at next login. This setting doesn't
* apply when [the user signs in via a third-party identity
* provider](https://support.google.com/a/answer/60224).
* @return value or {@code null} for none
*/
public java.lang.Boolean getChangePasswordAtNextLogin() {
return changePasswordAtNextLogin;
}
/**
* Indicates if the user is forced to change their password at next login. This setting doesn't
* apply when [the user signs in via a third-party identity
* provider](https://support.google.com/a/answer/60224).
* @param changePasswordAtNextLogin changePasswordAtNextLogin or {@code null} for none
*/
public User setChangePasswordAtNextLogin(java.lang.Boolean changePasswordAtNextLogin) {
this.changePasswordAtNextLogin = changePasswordAtNextLogin;
return this;
}
/**
* User's G Suite account creation time. (Read-only)
* @return value or {@code null} for none
*/
public com.google.api.client.util.DateTime getCreationTime() {
return creationTime;
}
/**
* User's G Suite account creation time. (Read-only)
* @param creationTime creationTime or {@code null} for none
*/
public User setCreationTime(com.google.api.client.util.DateTime creationTime) {
this.creationTime = creationTime;
return this;
}
/**
* Custom fields of the user. The key is a `schema_name` and its values are `'field_name':
* 'field_value'`.
* @return value or {@code null} for none
*/
public java.util.Map> getCustomSchemas() {
return customSchemas;
}
/**
* Custom fields of the user. The key is a `schema_name` and its values are `'field_name':
* 'field_value'`.
* @param customSchemas customSchemas or {@code null} for none
*/
public User setCustomSchemas(java.util.Map> customSchemas) {
this.customSchemas = customSchemas;
return this;
}
/**
* Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides
* /manage-users.html#get_all_users). You can use the alias `my_customer` to represent your
* account's `customerId`. As a reseller administrator, you can use the resold customer account's
* `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter
* of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
* @return value or {@code null} for none
*/
public java.lang.String getCustomerId() {
return customerId;
}
/**
* Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides
* /manage-users.html#get_all_users). You can use the alias `my_customer` to represent your
* account's `customerId`. As a reseller administrator, you can use the resold customer account's
* `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter
* of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
* @param customerId customerId or {@code null} for none
*/
public User setCustomerId(java.lang.String customerId) {
this.customerId = customerId;
return this;
}
/**
* @return value or {@code null} for none
*/
public com.google.api.client.util.DateTime getDeletionTime() {
return deletionTime;
}
/**
* @param deletionTime deletionTime or {@code null} for none
*/
public User setDeletionTime(com.google.api.client.util.DateTime deletionTime) {
this.deletionTime = deletionTime;
return this;
}
/**
* A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getEmails() {
return emails;
}
/**
* A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.
* @param emails emails or {@code null} for none
*/
public User setEmails(java.lang.Object emails) {
this.emails = emails;
return this;
}
/**
* Output only. ETag of the resource.
* @return value or {@code null} for none
*/
public java.lang.String getEtag() {
return etag;
}
/**
* Output only. ETag of the resource.
* @param etag etag or {@code null} for none
*/
public User setEtag(java.lang.String etag) {
this.etag = etag;
return this;
}
/**
* A list of external IDs for the user, such as an employee or network ID. The maximum allowed
* data size for this field is 2Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getExternalIds() {
return externalIds;
}
/**
* A list of external IDs for the user, such as an employee or network ID. The maximum allowed
* data size for this field is 2Kb.
* @param externalIds externalIds or {@code null} for none
*/
public User setExternalIds(java.lang.Object externalIds) {
this.externalIds = externalIds;
return this;
}
/**
* The user's gender. The maximum allowed data size for this field is 1Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getGender() {
return gender;
}
/**
* The user's gender. The maximum allowed data size for this field is 1Kb.
* @param gender gender or {@code null} for none
*/
public User setGender(java.lang.Object gender) {
this.gender = gender;
return this;
}
/**
* Stores the hash format of the `password` property. The following `hashFunction` values are
* allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA1` - Accepts simple hex-encoded
* values. * `crypt` - Compliant with the [C crypt
* library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix
* `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds
* are specified as part of the prefix, they must be 10,000 or fewer.
* @return value or {@code null} for none
*/
public java.lang.String getHashFunction() {
return hashFunction;
}
/**
* Stores the hash format of the `password` property. The following `hashFunction` values are
* allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA1` - Accepts simple hex-encoded
* values. * `crypt` - Compliant with the [C crypt
* library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix
* `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds
* are specified as part of the prefix, they must be 10,000 or fewer.
* @param hashFunction hashFunction or {@code null} for none
*/
public User setHashFunction(java.lang.String hashFunction) {
this.hashFunction = hashFunction;
return this;
}
/**
* The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
* @return value or {@code null} for none
*/
public java.lang.String getId() {
return id;
}
/**
* The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
* @param id id or {@code null} for none
*/
public User setId(java.lang.String id) {
this.id = id;
return this;
}
/**
* The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties.
* But, only one of these ims properties can be the primary IM contact. The maximum allowed data
* size for this field is 2Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getIms() {
return ims;
}
/**
* The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties.
* But, only one of these ims properties can be the primary IM contact. The maximum allowed data
* size for this field is 2Kb.
* @param ims ims or {@code null} for none
*/
public User setIms(java.lang.Object ims) {
this.ims = ims;
return this;
}
/**
* Indicates if the user's profile is visible in the Google Workspace global address list when the
* contact sharing feature is enabled for the domain. For more information about excluding user
* profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
* @return value or {@code null} for none
*/
public java.lang.Boolean getIncludeInGlobalAddressList() {
return includeInGlobalAddressList;
}
/**
* Indicates if the user's profile is visible in the Google Workspace global address list when the
* contact sharing feature is enabled for the domain. For more information about excluding user
* profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
* @param includeInGlobalAddressList includeInGlobalAddressList or {@code null} for none
*/
public User setIncludeInGlobalAddressList(java.lang.Boolean includeInGlobalAddressList) {
this.includeInGlobalAddressList = includeInGlobalAddressList;
return this;
}
/**
* If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).
* @return value or {@code null} for none
*/
public java.lang.Boolean getIpWhitelisted() {
return ipWhitelisted;
}
/**
* If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).
* @param ipWhitelisted ipWhitelisted or {@code null} for none
*/
public User setIpWhitelisted(java.lang.Boolean ipWhitelisted) {
this.ipWhitelisted = ipWhitelisted;
return this;
}
/**
* Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can
* only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-
* users.html#make_admin) operation ( [makeAdmin](/admin-
* sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert
* ](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-
* sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
* @return value or {@code null} for none
*/
public java.lang.Boolean getIsAdmin() {
return isAdmin;
}
/**
* Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can
* only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-
* users.html#make_admin) operation ( [makeAdmin](/admin-
* sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert
* ](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-
* sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
* @param isAdmin isAdmin or {@code null} for none
*/
public User setIsAdmin(java.lang.Boolean isAdmin) {
this.isAdmin = isAdmin;
return this;
}
/**
* Output only. Indicates if the user is a delegated administrator. Delegated administrators are
* supported by the API but cannot create or undelete users, or make users administrators. These
* requests are ignored by the API service. Roles and privileges for administrators are assigned
* using the [Admin console](https://support.google.com/a/answer/33325).
* @return value or {@code null} for none
*/
public java.lang.Boolean getIsDelegatedAdmin() {
return isDelegatedAdmin;
}
/**
* Output only. Indicates if the user is a delegated administrator. Delegated administrators are
* supported by the API but cannot create or undelete users, or make users administrators. These
* requests are ignored by the API service. Roles and privileges for administrators are assigned
* using the [Admin console](https://support.google.com/a/answer/33325).
* @param isDelegatedAdmin isDelegatedAdmin or {@code null} for none
*/
public User setIsDelegatedAdmin(java.lang.Boolean isDelegatedAdmin) {
this.isDelegatedAdmin = isDelegatedAdmin;
return this;
}
/**
* Output only. Is 2-step verification enforced (Read-only)
* @return value or {@code null} for none
*/
public java.lang.Boolean getIsEnforcedIn2Sv() {
return isEnforcedIn2Sv;
}
/**
* Output only. Is 2-step verification enforced (Read-only)
* @param isEnforcedIn2Sv isEnforcedIn2Sv or {@code null} for none
*/
public User setIsEnforcedIn2Sv(java.lang.Boolean isEnforcedIn2Sv) {
this.isEnforcedIn2Sv = isEnforcedIn2Sv;
return this;
}
/**
* Output only. Is enrolled in 2-step verification (Read-only)
* @return value or {@code null} for none
*/
public java.lang.Boolean getIsEnrolledIn2Sv() {
return isEnrolledIn2Sv;
}
/**
* Output only. Is enrolled in 2-step verification (Read-only)
* @param isEnrolledIn2Sv isEnrolledIn2Sv or {@code null} for none
*/
public User setIsEnrolledIn2Sv(java.lang.Boolean isEnrolledIn2Sv) {
this.isEnrolledIn2Sv = isEnrolledIn2Sv;
return this;
}
/**
* Output only. Indicates if the user's Google mailbox is created. This property is only
* applicable if the user has been assigned a Gmail license.
* @return value or {@code null} for none
*/
public java.lang.Boolean getIsMailboxSetup() {
return isMailboxSetup;
}
/**
* Output only. Indicates if the user's Google mailbox is created. This property is only
* applicable if the user has been assigned a Gmail license.
* @param isMailboxSetup isMailboxSetup or {@code null} for none
*/
public User setIsMailboxSetup(java.lang.Boolean isMailboxSetup) {
this.isMailboxSetup = isMailboxSetup;
return this;
}
/**
* The user's keywords. The maximum allowed data size for this field is 1Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getKeywords() {
return keywords;
}
/**
* The user's keywords. The maximum allowed data size for this field is 1Kb.
* @param keywords keywords or {@code null} for none
*/
public User setKeywords(java.lang.Object keywords) {
this.keywords = keywords;
return this;
}
/**
* Output only. The type of the API resource. For Users resources, the value is
* `admin#directory#user`.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* Output only. The type of the API resource. For Users resources, the value is
* `admin#directory#user`.
* @param kind kind or {@code null} for none
*/
public User setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* The user's languages. The maximum allowed data size for this field is 1Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getLanguages() {
return languages;
}
/**
* The user's languages. The maximum allowed data size for this field is 1Kb.
* @param languages languages or {@code null} for none
*/
public User setLanguages(java.lang.Object languages) {
this.languages = languages;
return this;
}
/**
* User's last login time. (Read-only)
* @return value or {@code null} for none
*/
public com.google.api.client.util.DateTime getLastLoginTime() {
return lastLoginTime;
}
/**
* User's last login time. (Read-only)
* @param lastLoginTime lastLoginTime or {@code null} for none
*/
public User setLastLoginTime(com.google.api.client.util.DateTime lastLoginTime) {
this.lastLoginTime = lastLoginTime;
return this;
}
/**
* The user's locations. The maximum allowed data size for this field is 10Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getLocations() {
return locations;
}
/**
* The user's locations. The maximum allowed data size for this field is 10Kb.
* @param locations locations or {@code null} for none
*/
public User setLocations(java.lang.Object locations) {
this.locations = locations;
return this;
}
/**
* Holds the given and family names of the user, and the read-only `fullName` value. The maximum
* number of characters in the `givenName` and in the `familyName` values is 60. In addition, name
* values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9),
* dashes (-), forward slashes (/), and periods (.). For more information about character usage
* rules, see the [administration help center](https://support.google.com/a/answer/9193374).
* Maximum allowed data size for this field is 1Kb.
* @return value or {@code null} for none
*/
public UserName getName() {
return name;
}
/**
* Holds the given and family names of the user, and the read-only `fullName` value. The maximum
* number of characters in the `givenName` and in the `familyName` values is 60. In addition, name
* values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9),
* dashes (-), forward slashes (/), and periods (.). For more information about character usage
* rules, see the [administration help center](https://support.google.com/a/answer/9193374).
* Maximum allowed data size for this field is 1Kb.
* @param name name or {@code null} for none
*/
public User setName(UserName name) {
this.name = name;
return this;
}
/**
* Output only. List of the user's non-editable alias email addresses. These are typically outside
* the account's primary domain or sub-domain.
* @return value or {@code null} for none
*/
public java.util.List getNonEditableAliases() {
return nonEditableAliases;
}
/**
* Output only. List of the user's non-editable alias email addresses. These are typically outside
* the account's primary domain or sub-domain.
* @param nonEditableAliases nonEditableAliases or {@code null} for none
*/
public User setNonEditableAliases(java.util.List nonEditableAliases) {
this.nonEditableAliases = nonEditableAliases;
return this;
}
/**
* Notes for the user.
* @return value or {@code null} for none
*/
public java.lang.Object getNotes() {
return notes;
}
/**
* Notes for the user.
* @param notes notes or {@code null} for none
*/
public User setNotes(java.lang.Object notes) {
this.notes = notes;
return this;
}
/**
* The full path of the parent organization associated with the user. If the parent organization
* is the top-level, it is represented as a forward slash (`/`).
* @return value or {@code null} for none
*/
public java.lang.String getOrgUnitPath() {
return orgUnitPath;
}
/**
* The full path of the parent organization associated with the user. If the parent organization
* is the top-level, it is represented as a forward slash (`/`).
* @param orgUnitPath orgUnitPath or {@code null} for none
*/
public User setOrgUnitPath(java.lang.String orgUnitPath) {
this.orgUnitPath = orgUnitPath;
return this;
}
/**
* A list of organizations the user belongs to. The maximum allowed data size for this field is
* 10Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getOrganizations() {
return organizations;
}
/**
* A list of organizations the user belongs to. The maximum allowed data size for this field is
* 10Kb.
* @param organizations organizations or {@code null} for none
*/
public User setOrganizations(java.lang.Object organizations) {
this.organizations = organizations;
return this;
}
/**
* User's password
* @return value or {@code null} for none
*/
public java.lang.String getPassword() {
return password;
}
/**
* User's password
* @param password password or {@code null} for none
*/
public User setPassword(java.lang.String password) {
this.password = password;
return this;
}
/**
* A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getPhones() {
return phones;
}
/**
* A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.
* @param phones phones or {@code null} for none
*/
public User setPhones(java.lang.Object phones) {
this.phones = phones;
return this;
}
/**
* A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information
* for the user.
* @return value or {@code null} for none
*/
public java.lang.Object getPosixAccounts() {
return posixAccounts;
}
/**
* A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information
* for the user.
* @param posixAccounts posixAccounts or {@code null} for none
*/
public User setPosixAccounts(java.lang.Object posixAccounts) {
this.posixAccounts = posixAccounts;
return this;
}
/**
* The user's primary email address. This property is required in a request to create a user
* account. The `primaryEmail` must be unique and cannot be an alias of another user.
* @return value or {@code null} for none
*/
public java.lang.String getPrimaryEmail() {
return primaryEmail;
}
/**
* The user's primary email address. This property is required in a request to create a user
* account. The `primaryEmail` must be unique and cannot be an alias of another user.
* @param primaryEmail primaryEmail or {@code null} for none
*/
public User setPrimaryEmail(java.lang.String primaryEmail) {
this.primaryEmail = primaryEmail;
return this;
}
/**
* Recovery email of the user.
* @return value or {@code null} for none
*/
public java.lang.String getRecoveryEmail() {
return recoveryEmail;
}
/**
* Recovery email of the user.
* @param recoveryEmail recoveryEmail or {@code null} for none
*/
public User setRecoveryEmail(java.lang.String recoveryEmail) {
this.recoveryEmail = recoveryEmail;
return this;
}
/**
* Recovery phone of the user. The phone number must be in the E.164 format, starting with the
* plus sign (+). Example: *+16506661212*.
* @return value or {@code null} for none
*/
public java.lang.String getRecoveryPhone() {
return recoveryPhone;
}
/**
* Recovery phone of the user. The phone number must be in the E.164 format, starting with the
* plus sign (+). Example: *+16506661212*.
* @param recoveryPhone recoveryPhone or {@code null} for none
*/
public User setRecoveryPhone(java.lang.String recoveryPhone) {
this.recoveryPhone = recoveryPhone;
return this;
}
/**
* A list of the user's relationships to other users. The maximum allowed data size for this field
* is 2Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getRelations() {
return relations;
}
/**
* A list of the user's relationships to other users. The maximum allowed data size for this field
* is 2Kb.
* @param relations relations or {@code null} for none
*/
public User setRelations(java.lang.Object relations) {
this.relations = relations;
return this;
}
/**
* A list of SSH public keys.
* @return value or {@code null} for none
*/
public java.lang.Object getSshPublicKeys() {
return sshPublicKeys;
}
/**
* A list of SSH public keys.
* @param sshPublicKeys sshPublicKeys or {@code null} for none
*/
public User setSshPublicKeys(java.lang.Object sshPublicKeys) {
this.sshPublicKeys = sshPublicKeys;
return this;
}
/**
* Indicates if user is suspended.
* @return value or {@code null} for none
*/
public java.lang.Boolean getSuspended() {
return suspended;
}
/**
* Indicates if user is suspended.
* @param suspended suspended or {@code null} for none
*/
public User setSuspended(java.lang.Boolean suspended) {
this.suspended = suspended;
return this;
}
/**
* Output only. Has the reason a user account is suspended either by the administrator or by
* Google at the time of suspension. The property is returned only if the `suspended` property is
* `true`.
* @return value or {@code null} for none
*/
public java.lang.String getSuspensionReason() {
return suspensionReason;
}
/**
* Output only. Has the reason a user account is suspended either by the administrator or by
* Google at the time of suspension. The property is returned only if the `suspended` property is
* `true`.
* @param suspensionReason suspensionReason or {@code null} for none
*/
public User setSuspensionReason(java.lang.String suspensionReason) {
this.suspensionReason = suspensionReason;
return this;
}
/**
* Output only. ETag of the user's photo (Read-only)
* @return value or {@code null} for none
*/
public java.lang.String getThumbnailPhotoEtag() {
return thumbnailPhotoEtag;
}
/**
* Output only. ETag of the user's photo (Read-only)
* @param thumbnailPhotoEtag thumbnailPhotoEtag or {@code null} for none
*/
public User setThumbnailPhotoEtag(java.lang.String thumbnailPhotoEtag) {
this.thumbnailPhotoEtag = thumbnailPhotoEtag;
return this;
}
/**
* Output only. Photo Url of the user (Read-only)
* @return value or {@code null} for none
*/
public java.lang.String getThumbnailPhotoUrl() {
return thumbnailPhotoUrl;
}
/**
* Output only. Photo Url of the user (Read-only)
* @param thumbnailPhotoUrl thumbnailPhotoUrl or {@code null} for none
*/
public User setThumbnailPhotoUrl(java.lang.String thumbnailPhotoUrl) {
this.thumbnailPhotoUrl = thumbnailPhotoUrl;
return this;
}
/**
* The user's websites. The maximum allowed data size for this field is 2Kb.
* @return value or {@code null} for none
*/
public java.lang.Object getWebsites() {
return websites;
}
/**
* The user's websites. The maximum allowed data size for this field is 2Kb.
* @param websites websites or {@code null} for none
*/
public User setWebsites(java.lang.Object websites) {
this.websites = websites;
return this;
}
@Override
public User set(String fieldName, Object value) {
return (User) super.set(fieldName, value);
}
@Override
public User clone() {
return (User) super.clone();
}
}