Interface UserOrBuilder (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public interface UserOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccountExpirationTime()

public abstract Timestamp getAccountExpirationTime()

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Returns
Type	Description
Timestamp	The accountExpirationTime.

getAccountExpirationTimeOrBuilder()

public abstract TimestampOrBuilder getAccountExpirationTimeOrBuilder()

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Returns
Type	Description
TimestampOrBuilder

getAccountLockoutTime()

public abstract Timestamp getAccountLockoutTime()

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Returns
Type	Description
Timestamp	The accountLockoutTime.

getAccountLockoutTimeOrBuilder()

public abstract TimestampOrBuilder getAccountLockoutTimeOrBuilder()

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Returns
Type	Description
TimestampOrBuilder

getAccountType()

public abstract User.AccountType getAccountType()

Type of user account (for example, service, domain, or cloud). This is somewhat aligned to: https://attack.mitre.org/techniques/T1078/

.google.backstory.User.AccountType account_type = 9;

Returns
Type	Description
User.AccountType	The accountType.

getAccountTypeValue()

public abstract int getAccountTypeValue()

Type of user account (for example, service, domain, or cloud). This is somewhat aligned to: https://attack.mitre.org/techniques/T1078/

.google.backstory.User.AccountType account_type = 9;

Returns
Type	Description
int	The enum numeric value on the wire for accountType.

getAttribute()

public abstract Attribute getAttribute()

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Returns
Type	Description
Attribute	The attribute.

getAttributeOrBuilder()

public abstract AttributeOrBuilder getAttributeOrBuilder()

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Returns
Type	Description
AttributeOrBuilder

getCompanyName()

public abstract String getCompanyName()

User job company name.

string company_name = 602;

Returns
Type	Description
String	The companyName.

getCompanyNameBytes()

public abstract ByteString getCompanyNameBytes()

User job company name.

string company_name = 602;

Returns
Type	Description
ByteString	The bytes for companyName.

getDepartment(int index)

public abstract String getDepartment(int index)

User job department

repeated string department = 603;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The department at the given index.

getDepartmentBytes(int index)

public abstract ByteString getDepartmentBytes(int index)

User job department

repeated string department = 603;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the department at the given index.

getDepartmentCount()

public abstract int getDepartmentCount()

User job department

repeated string department = 603;

Returns
Type	Description
int	The count of department.

getDepartmentList()

public abstract List<String> getDepartmentList()

User job department

repeated string department = 603;

Returns
Type	Description
List<String>	A list containing the department.

getEmailAddresses(int index)

public abstract String getEmailAddresses(int index)

Email addresses of the user. This field can be used as an entity indicator for user entities.

repeated string email_addresses = 5;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The emailAddresses at the given index.

getEmailAddressesBytes(int index)

public abstract ByteString getEmailAddressesBytes(int index)

Email addresses of the user. This field can be used as an entity indicator for user entities.

repeated string email_addresses = 5;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the emailAddresses at the given index.

getEmailAddressesCount()

public abstract int getEmailAddressesCount()

Email addresses of the user. This field can be used as an entity indicator for user entities.

repeated string email_addresses = 5;

Returns
Type	Description
int	The count of emailAddresses.

getEmailAddressesList()

public abstract List<String> getEmailAddressesList()

Email addresses of the user. This field can be used as an entity indicator for user entities.

repeated string email_addresses = 5;

Returns
Type	Description
List<String>	A list containing the emailAddresses.

getEmployeeId()

public abstract String getEmployeeId()

Human capital management identifier. This field can be used as an entity indicator for user entities.

string employee_id = 6;

Returns
Type	Description
String	The employeeId.

getEmployeeIdBytes()

public abstract ByteString getEmployeeIdBytes()

Human capital management identifier. This field can be used as an entity indicator for user entities.

string employee_id = 6;

Returns
Type	Description
ByteString	The bytes for employeeId.

getFirstName()

public abstract String getFirstName()

First name of the user (e.g. "John").

string first_name = 100;

Returns
Type	Description
String	The firstName.

getFirstNameBytes()

public abstract ByteString getFirstNameBytes()

First name of the user (e.g. "John").

string first_name = 100;

Returns
Type	Description
ByteString	The bytes for firstName.

getFirstSeenTime()

public abstract Timestamp getFirstSeenTime()

The first observed time for a user. The value is calculated on the basis of the first time the identifier was observed.

.google.protobuf.Timestamp first_seen_time = 10;

Returns
Type	Description
Timestamp	The firstSeenTime.

getFirstSeenTimeOrBuilder()

public abstract TimestampOrBuilder getFirstSeenTimeOrBuilder()

The first observed time for a user. The value is calculated on the basis of the first time the identifier was observed.

.google.protobuf.Timestamp first_seen_time = 10;

Returns
Type	Description
TimestampOrBuilder

getGroupIdentifiers(int index)

public abstract String getGroupIdentifiers(int index)

Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).

repeated string group_identifiers = 200;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The groupIdentifiers at the given index.

getGroupIdentifiersBytes(int index)

public abstract ByteString getGroupIdentifiersBytes(int index)

Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).

repeated string group_identifiers = 200;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the groupIdentifiers at the given index.

getGroupIdentifiersCount()

public abstract int getGroupIdentifiersCount()

Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).

repeated string group_identifiers = 200;

Returns
Type	Description
int	The count of groupIdentifiers.

getGroupIdentifiersList()

public abstract List<String> getGroupIdentifiersList()

Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).

repeated string group_identifiers = 200;

Returns
Type	Description
List<String>	A list containing the groupIdentifiers.

getGroupid() (deprecated)

public abstract String getGroupid()

Deprecated. google.backstory.User.groupid is deprecated. See backstory/udm.proto;l=4784

The ID of the group that the user belongs to. Deprecated in favor of the repeated group_identifiers field.

string groupid = 2 [deprecated = true];

Returns
Type	Description
String	The groupid.

getGroupidBytes() (deprecated)

public abstract ByteString getGroupidBytes()

Deprecated. google.backstory.User.groupid is deprecated. See backstory/udm.proto;l=4784

The ID of the group that the user belongs to. Deprecated in favor of the repeated group_identifiers field.

string groupid = 2 [deprecated = true];

Returns
Type	Description
ByteString	The bytes for groupid.

getHireDate()

public abstract Timestamp getHireDate()

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Returns
Type	Description
Timestamp	The hireDate.

getHireDateOrBuilder()

public abstract TimestampOrBuilder getHireDateOrBuilder()

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Returns
Type	Description
TimestampOrBuilder

getLastBadPasswordAttemptTime()

public abstract Timestamp getLastBadPasswordAttemptTime()

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Returns
Type	Description
Timestamp	The lastBadPasswordAttemptTime.

getLastBadPasswordAttemptTimeOrBuilder()

public abstract TimestampOrBuilder getLastBadPasswordAttemptTimeOrBuilder()

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Returns
Type	Description
TimestampOrBuilder

getLastLoginTime()

public abstract Timestamp getLastLoginTime()

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Returns
Type	Description
Timestamp	The lastLoginTime.

getLastLoginTimeOrBuilder()

public abstract TimestampOrBuilder getLastLoginTimeOrBuilder()

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Returns
Type	Description
TimestampOrBuilder

getLastName()

public abstract String getLastName()

Last name of the user (e.g. "Locke").

string last_name = 102;

Returns
Type	Description
String	The lastName.

getLastNameBytes()

public abstract ByteString getLastNameBytes()

Last name of the user (e.g. "Locke").

string last_name = 102;

Returns
Type	Description
ByteString	The bytes for lastName.

getLastPasswordChangeTime()

public abstract Timestamp getLastPasswordChangeTime()

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Returns
Type	Description
Timestamp	The lastPasswordChangeTime.

getLastPasswordChangeTimeOrBuilder()

public abstract TimestampOrBuilder getLastPasswordChangeTimeOrBuilder()

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Returns
Type	Description
TimestampOrBuilder

getManagers(int index)

public abstract User getManagers(int index)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name	Description
index	int

Returns
Type	Description
User

getManagersCount()

public abstract int getManagersCount()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type	Description
int

getManagersList()

public abstract List<User> getManagersList()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type	Description
List<User>

getManagersOrBuilder(int index)

public abstract UserOrBuilder getManagersOrBuilder(int index)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name	Description
index	int

Returns
Type	Description
UserOrBuilder

getManagersOrBuilderList()

public abstract List<? extends UserOrBuilder> getManagersOrBuilderList()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type	Description
List<? extends com.google.backstory.UserOrBuilder>

getMiddleName()

public abstract String getMiddleName()

Middle name of the user.

string middle_name = 101;

Returns
Type	Description
String	The middleName.

getMiddleNameBytes()

public abstract ByteString getMiddleNameBytes()

Middle name of the user.

string middle_name = 101;

Returns
Type	Description
ByteString	The bytes for middleName.

getOfficeAddress()

public abstract Location getOfficeAddress()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type	Description
Location	The officeAddress.

getOfficeAddressOrBuilder()

public abstract LocationOrBuilder getOfficeAddressOrBuilder()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type	Description
LocationOrBuilder

getPasswordExpirationTime()

public abstract Timestamp getPasswordExpirationTime()

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Returns
Type	Description
Timestamp	The passwordExpirationTime.

getPasswordExpirationTimeOrBuilder()

public abstract TimestampOrBuilder getPasswordExpirationTimeOrBuilder()

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Returns
Type	Description
TimestampOrBuilder

getPersonalAddress()

public abstract Location getPersonalAddress()

Personal address of the user.

.google.backstory.Location personal_address = 104;

Returns
Type	Description
Location	The personalAddress.

getPersonalAddressOrBuilder()

public abstract LocationOrBuilder getPersonalAddressOrBuilder()

Personal address of the user.

.google.backstory.Location personal_address = 104;

Returns
Type	Description
LocationOrBuilder

getPhoneNumbers(int index)

public abstract String getPhoneNumbers(int index)

Phone numbers for the user.

repeated string phone_numbers = 103;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The phoneNumbers at the given index.

getPhoneNumbersBytes(int index)

public abstract ByteString getPhoneNumbersBytes(int index)

Phone numbers for the user.

repeated string phone_numbers = 103;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the phoneNumbers at the given index.

getPhoneNumbersCount()

public abstract int getPhoneNumbersCount()

Phone numbers for the user.

repeated string phone_numbers = 103;

Returns
Type	Description
int	The count of phoneNumbers.

getPhoneNumbersList()

public abstract List<String> getPhoneNumbersList()

Phone numbers for the user.

repeated string phone_numbers = 103;

Returns
Type	Description
List<String>	A list containing the phoneNumbers.

getProductObjectId()

public abstract String getProductObjectId()

A vendor-specific identifier to uniquely identify the entity (e.g. a GUID, LDAP, OID, or similar). This field can be used as an entity indicator for user entities.

string product_object_id = 7;

Returns
Type	Description
String	The productObjectId.

getProductObjectIdBytes()

public abstract ByteString getProductObjectIdBytes()

A vendor-specific identifier to uniquely identify the entity (e.g. a GUID, LDAP, OID, or similar). This field can be used as an entity indicator for user entities.

string product_object_id = 7;

Returns
Type	Description
ByteString	The bytes for productObjectId.

getRoleDescription() (deprecated)

public abstract String getRoleDescription()

Deprecated. google.backstory.User.role_description is deprecated. See backstory/udm.proto;l=4854

System role description for user. Deprecated: use attribute.roles.

string role_description = 703 [deprecated = true];

Returns
Type	Description
String	The roleDescription.

getRoleDescriptionBytes() (deprecated)

public abstract ByteString getRoleDescriptionBytes()

Deprecated. google.backstory.User.role_description is deprecated. See backstory/udm.proto;l=4854

System role description for user. Deprecated: use attribute.roles.

string role_description = 703 [deprecated = true];

Returns
Type	Description
ByteString	The bytes for roleDescription.

getRoleName() (deprecated)

public abstract String getRoleName()

Deprecated. google.backstory.User.role_name is deprecated. See backstory/udm.proto;l=4850

System role name for user. Deprecated: use attribute.roles.

string role_name = 702 [deprecated = true];

Returns
Type	Description
String	The roleName.

getRoleNameBytes() (deprecated)

public abstract ByteString getRoleNameBytes()

Deprecated. google.backstory.User.role_name is deprecated. See backstory/udm.proto;l=4850

System role name for user. Deprecated: use attribute.roles.

string role_name = 702 [deprecated = true];

Returns
Type	Description
ByteString	The bytes for roleName.

getTerminationDate()

public abstract Timestamp getTerminationDate()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type	Description
Timestamp	The terminationDate.

getTerminationDateOrBuilder()

public abstract TimestampOrBuilder getTerminationDateOrBuilder()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type	Description
TimestampOrBuilder

getTimeOff(int index)

public abstract TimeOff getTimeOff(int index)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameter
Name	Description
index	int

Returns
Type	Description
TimeOff

getTimeOffCount()

public abstract int getTimeOffCount()

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Returns
Type	Description
int

getTimeOffList()

public abstract List<TimeOff> getTimeOffList()

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Returns
Type	Description
List<TimeOff>

getTimeOffOrBuilder(int index)

public abstract TimeOffOrBuilder getTimeOffOrBuilder(int index)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameter
Name	Description
index	int

Returns
Type	Description
TimeOffOrBuilder

getTimeOffOrBuilderList()

public abstract List<? extends TimeOffOrBuilder> getTimeOffOrBuilderList()

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Returns
Type	Description
List<? extends com.google.backstory.TimeOffOrBuilder>

getTitle()

public abstract String getTitle()

User job title.

string title = 601;

Returns
Type	Description
String	The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

User job title.

string title = 601;

Returns
Type	Description
ByteString	The bytes for title.

getUserAuthenticationStatus()

public abstract Authentication.AuthenticationStatus getUserAuthenticationStatus()

System authentication status for user.

.google.backstory.Authentication.AuthenticationStatus user_authentication_status = 701;

Returns
Type	Description
Authentication.AuthenticationStatus	The userAuthenticationStatus.

getUserAuthenticationStatusValue()

public abstract int getUserAuthenticationStatusValue()

System authentication status for user.

.google.backstory.Authentication.AuthenticationStatus user_authentication_status = 701;

Returns
Type	Description
int	The enum numeric value on the wire for userAuthenticationStatus.

getUserDisplayName()

public abstract String getUserDisplayName()

The display name of the user (e.g. "John Locke").

string user_display_name = 3;

Returns
Type	Description
String	The userDisplayName.

getUserDisplayNameBytes()

public abstract ByteString getUserDisplayNameBytes()

The display name of the user (e.g. "John Locke").

string user_display_name = 3;

Returns
Type	Description
ByteString	The bytes for userDisplayName.

getUserRole() (deprecated)

public abstract User.Role getUserRole()

Deprecated. google.backstory.User.user_role is deprecated. See backstory/udm.proto;l=4858

System role for user. Deprecated: use attribute.roles.

.google.backstory.User.Role user_role = 704 [deprecated = true];

Returns
Type	Description
User.Role	The userRole.

getUserRoleValue() (deprecated)

public abstract int getUserRoleValue()

Deprecated. google.backstory.User.user_role is deprecated. See backstory/udm.proto;l=4858

System role for user. Deprecated: use attribute.roles.

.google.backstory.User.Role user_role = 704 [deprecated = true];

Returns
Type	Description
int	The enum numeric value on the wire for userRole.

getUserid()

public abstract String getUserid()

The ID of the user. This field can be used as an entity indicator for user entities.

string userid = 1;

Returns
Type	Description
String	The userid.

getUseridBytes()

public abstract ByteString getUseridBytes()

The ID of the user. This field can be used as an entity indicator for user entities.

string userid = 1;

Returns
Type	Description
ByteString	The bytes for userid.

getWindowsSid()

public abstract String getWindowsSid()

The Microsoft Windows SID of the user. This field can be used as an entity indicator for user entities.

string windows_sid = 4;

Returns
Type	Description
String	The windowsSid.

getWindowsSidBytes()

public abstract ByteString getWindowsSidBytes()

The Microsoft Windows SID of the user. This field can be used as an entity indicator for user entities.

string windows_sid = 4;

Returns
Type	Description
ByteString	The bytes for windowsSid.

hasAccountExpirationTime()

public abstract boolean hasAccountExpirationTime()

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Returns
Type	Description
boolean	Whether the accountExpirationTime field is set.

hasAccountLockoutTime()

public abstract boolean hasAccountLockoutTime()

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Returns
Type	Description
boolean	Whether the accountLockoutTime field is set.

hasAttribute()

public abstract boolean hasAttribute()

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Returns
Type	Description
boolean	Whether the attribute field is set.

hasFirstSeenTime()

public abstract boolean hasFirstSeenTime()

The first observed time for a user. The value is calculated on the basis of the first time the identifier was observed.

.google.protobuf.Timestamp first_seen_time = 10;

Returns
Type	Description
boolean	Whether the firstSeenTime field is set.

hasHireDate()

public abstract boolean hasHireDate()

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Returns
Type	Description
boolean	Whether the hireDate field is set.

hasLastBadPasswordAttemptTime()

public abstract boolean hasLastBadPasswordAttemptTime()

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Returns
Type	Description
boolean	Whether the lastBadPasswordAttemptTime field is set.

hasLastLoginTime()

public abstract boolean hasLastLoginTime()

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Returns
Type	Description
boolean	Whether the lastLoginTime field is set.

hasLastPasswordChangeTime()

public abstract boolean hasLastPasswordChangeTime()

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Returns
Type	Description
boolean	Whether the lastPasswordChangeTime field is set.

hasOfficeAddress()

public abstract boolean hasOfficeAddress()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type	Description
boolean	Whether the officeAddress field is set.

hasPasswordExpirationTime()

public abstract boolean hasPasswordExpirationTime()

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Returns
Type	Description
boolean	Whether the passwordExpirationTime field is set.

hasPersonalAddress()

public abstract boolean hasPersonalAddress()

Personal address of the user.

.google.backstory.Location personal_address = 104;

Returns
Type	Description
boolean	Whether the personalAddress field is set.

hasTerminationDate()

public abstract boolean hasTerminationDate()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type	Description
boolean	Whether the terminationDate field is set.