Class User.Builder (0.3.0)

public static final class User.Builder extends GeneratedMessage.Builder<User.Builder> implements UserOrBuilder

Information about a user.

Protobuf type google.backstory.User

Implements

UserOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDepartment(Iterable<String> values)

public User.Builder addAllDepartment(Iterable<String> values)

User job department

repeated string department = 603;

Parameter
Name Description
values Iterable<String>

The department to add.

Returns
Type Description
User.Builder

This builder for chaining.

addAllEmailAddresses(Iterable<String> values)

public User.Builder addAllEmailAddresses(Iterable<String> values)

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
values Iterable<String>

The emailAddresses to add.

Returns
Type Description
User.Builder

This builder for chaining.

addAllGroupIdentifiers(Iterable<String> values)

public User.Builder addAllGroupIdentifiers(Iterable<String> values)

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
values Iterable<String>

The groupIdentifiers to add.

Returns
Type Description
User.Builder

This builder for chaining.

addAllManagers(Iterable<? extends User> values)

public User.Builder addAllManagers(Iterable<? extends User> values)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name Description
values Iterable<? extends com.google.backstory.User>
Returns
Type Description
User.Builder

addAllPhoneNumbers(Iterable<String> values)

public User.Builder addAllPhoneNumbers(Iterable<String> values)

Phone numbers for the user.

repeated string phone_numbers = 103;

Parameter
Name Description
values Iterable<String>

The phoneNumbers to add.

Returns
Type Description
User.Builder

This builder for chaining.

addAllTimeOff(Iterable<? extends TimeOff> values)

public User.Builder addAllTimeOff(Iterable<? extends TimeOff> values)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameter
Name Description
values Iterable<? extends com.google.backstory.TimeOff>
Returns
Type Description
User.Builder

addDepartment(String value)

public User.Builder addDepartment(String value)

User job department

repeated string department = 603;

Parameter
Name Description
value String

The department to add.

Returns
Type Description
User.Builder

This builder for chaining.

addDepartmentBytes(ByteString value)

public User.Builder addDepartmentBytes(ByteString value)

User job department

repeated string department = 603;

Parameter
Name Description
value ByteString

The bytes of the department to add.

Returns
Type Description
User.Builder

This builder for chaining.

addEmailAddresses(String value)

public User.Builder addEmailAddresses(String value)

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
value String

The emailAddresses to add.

Returns
Type Description
User.Builder

This builder for chaining.

addEmailAddressesBytes(ByteString value)

public User.Builder addEmailAddressesBytes(ByteString value)

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
value ByteString

The bytes of the emailAddresses to add.

Returns
Type Description
User.Builder

This builder for chaining.

addGroupIdentifiers(String value)

public User.Builder addGroupIdentifiers(String value)

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
value String

The groupIdentifiers to add.

Returns
Type Description
User.Builder

This builder for chaining.

addGroupIdentifiersBytes(ByteString value)

public User.Builder addGroupIdentifiersBytes(ByteString value)

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
value ByteString

The bytes of the groupIdentifiers to add.

Returns
Type Description
User.Builder

This builder for chaining.

addManagers(User value)

public User.Builder addManagers(User value)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name Description
value User
Returns
Type Description
User.Builder

addManagers(User.Builder builderForValue)

public User.Builder addManagers(User.Builder builderForValue)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name Description
builderForValue User.Builder
Returns
Type Description
User.Builder

addManagers(int index, User value)

public User.Builder addManagers(int index, User value)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameters
Name Description
index int
value User
Returns
Type Description
User.Builder

addManagers(int index, User.Builder builderForValue)

public User.Builder addManagers(int index, User.Builder builderForValue)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameters
Name Description
index int
builderForValue User.Builder
Returns
Type Description
User.Builder

addManagersBuilder()

public User.Builder addManagersBuilder()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type Description
User.Builder

addManagersBuilder(int index)

public User.Builder addManagersBuilder(int index)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name Description
index int
Returns
Type Description
User.Builder

addPhoneNumbers(String value)

public User.Builder addPhoneNumbers(String value)

Phone numbers for the user.

repeated string phone_numbers = 103;

Parameter
Name Description
value String

The phoneNumbers to add.

Returns
Type Description
User.Builder

This builder for chaining.

addPhoneNumbersBytes(ByteString value)

public User.Builder addPhoneNumbersBytes(ByteString value)

Phone numbers for the user.

repeated string phone_numbers = 103;

Parameter
Name Description
value ByteString

The bytes of the phoneNumbers to add.

Returns
Type Description
User.Builder

This builder for chaining.

addTimeOff(TimeOff value)

public User.Builder addTimeOff(TimeOff value)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameter
Name Description
value TimeOff
Returns
Type Description
User.Builder

addTimeOff(TimeOff.Builder builderForValue)

public User.Builder addTimeOff(TimeOff.Builder builderForValue)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameter
Name Description
builderForValue TimeOff.Builder
Returns
Type Description
User.Builder

addTimeOff(int index, TimeOff value)

public User.Builder addTimeOff(int index, TimeOff value)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameters
Name Description
index int
value TimeOff
Returns
Type Description
User.Builder

addTimeOff(int index, TimeOff.Builder builderForValue)

public User.Builder addTimeOff(int index, TimeOff.Builder builderForValue)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameters
Name Description
index int
builderForValue TimeOff.Builder
Returns
Type Description
User.Builder

addTimeOffBuilder()

public TimeOff.Builder addTimeOffBuilder()

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Returns
Type Description
TimeOff.Builder

addTimeOffBuilder(int index)

public TimeOff.Builder addTimeOffBuilder(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.Builder

build()

public User build()
Returns
Type Description
User

buildPartial()

public User buildPartial()
Returns
Type Description
User

clear()

public User.Builder clear()
Returns
Type Description
User.Builder
Overrides

clearAccountExpirationTime()

public User.Builder clearAccountExpirationTime()

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Returns
Type Description
User.Builder

clearAccountLockoutTime()

public User.Builder clearAccountLockoutTime()

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Returns
Type Description
User.Builder

clearAccountType()

public User.Builder clearAccountType()

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.Builder

This builder for chaining.

clearAttribute()

public User.Builder clearAttribute()

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Returns
Type Description
User.Builder

clearCompanyName()

public User.Builder clearCompanyName()

User job company name.

string company_name = 602;

Returns
Type Description
User.Builder

This builder for chaining.

clearDepartment()

public User.Builder clearDepartment()

User job department

repeated string department = 603;

Returns
Type Description
User.Builder

This builder for chaining.

clearEmailAddresses()

public User.Builder clearEmailAddresses()

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
User.Builder

This builder for chaining.

clearEmployeeId()

public User.Builder clearEmployeeId()

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

string employee_id = 6;

Returns
Type Description
User.Builder

This builder for chaining.

clearFirstName()

public User.Builder clearFirstName()

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

string first_name = 100;

Returns
Type Description
User.Builder

This builder for chaining.

clearFirstSeenTime()

public User.Builder clearFirstSeenTime()

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
User.Builder

clearGroupIdentifiers()

public User.Builder clearGroupIdentifiers()

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
User.Builder

This builder for chaining.

clearGroupid() (deprecated)

public User.Builder clearGroupid()

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
User.Builder

This builder for chaining.

clearHireDate()

public User.Builder clearHireDate()

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Returns
Type Description
User.Builder

clearLastBadPasswordAttemptTime()

public User.Builder clearLastBadPasswordAttemptTime()

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Returns
Type Description
User.Builder

clearLastLoginTime()

public User.Builder clearLastLoginTime()

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Returns
Type Description
User.Builder

clearLastName()

public User.Builder clearLastName()

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

string last_name = 102;

Returns
Type Description
User.Builder

This builder for chaining.

clearLastPasswordChangeTime()

public User.Builder clearLastPasswordChangeTime()

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Returns
Type Description
User.Builder

clearManagers()

public User.Builder clearManagers()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type Description
User.Builder

clearMiddleName()

public User.Builder clearMiddleName()

Middle name of the user.

string middle_name = 101;

Returns
Type Description
User.Builder

This builder for chaining.

clearOfficeAddress()

public User.Builder clearOfficeAddress()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type Description
User.Builder

clearPasswordExpirationTime()

public User.Builder clearPasswordExpirationTime()

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Returns
Type Description
User.Builder

clearPersonalAddress()

public User.Builder clearPersonalAddress()

Personal address of the user.

.google.backstory.Location personal_address = 104;

Returns
Type Description
User.Builder

clearPhoneNumbers()

public User.Builder clearPhoneNumbers()

Phone numbers for the user.

repeated string phone_numbers = 103;

Returns
Type Description
User.Builder

This builder for chaining.

clearProductObjectId()

public User.Builder clearProductObjectId()

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
User.Builder

This builder for chaining.

clearRoleDescription() (deprecated)

public User.Builder clearRoleDescription()

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
User.Builder

This builder for chaining.

clearRoleName() (deprecated)

public User.Builder clearRoleName()

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
User.Builder

This builder for chaining.

clearTerminationDate()

public User.Builder clearTerminationDate()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type Description
User.Builder

clearTimeOff()

public User.Builder clearTimeOff()

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Returns
Type Description
User.Builder

clearTitle()

public User.Builder clearTitle()

User job title.

string title = 601;

Returns
Type Description
User.Builder

This builder for chaining.

clearUserAuthenticationStatus()

public User.Builder clearUserAuthenticationStatus()

System authentication status for user.

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

Returns
Type Description
User.Builder

This builder for chaining.

clearUserDisplayName()

public User.Builder clearUserDisplayName()

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

string user_display_name = 3;

Returns
Type Description
User.Builder

This builder for chaining.

clearUserRole() (deprecated)

public User.Builder clearUserRole()

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.Builder

This builder for chaining.

clearUserid()

public User.Builder clearUserid()

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

string userid = 1;

Returns
Type Description
User.Builder

This builder for chaining.

clearWindowsSid()

public User.Builder clearWindowsSid()

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
User.Builder

This builder for chaining.

getAccountExpirationTime()

public Timestamp getAccountExpirationTime()

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Returns
Type Description
Timestamp

The accountExpirationTime.

getAccountExpirationTimeBuilder()

public Timestamp.Builder getAccountExpirationTimeBuilder()

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Returns
Type Description
Builder

getAccountExpirationTimeOrBuilder()

public TimestampOrBuilder getAccountExpirationTimeOrBuilder()

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Returns
Type Description
TimestampOrBuilder

getAccountLockoutTime()

public Timestamp getAccountLockoutTime()

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Returns
Type Description
Timestamp

The accountLockoutTime.

getAccountLockoutTimeBuilder()

public Timestamp.Builder getAccountLockoutTimeBuilder()

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Returns
Type Description
Builder

getAccountLockoutTimeOrBuilder()

public TimestampOrBuilder getAccountLockoutTimeOrBuilder()

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Returns
Type Description
TimestampOrBuilder

getAccountType()

public 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 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 Attribute getAttribute()

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Returns
Type Description
Attribute

The attribute.

getAttributeBuilder()

public Attribute.Builder getAttributeBuilder()

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Returns
Type Description
Attribute.Builder

getAttributeOrBuilder()

public AttributeOrBuilder getAttributeOrBuilder()

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Returns
Type Description
AttributeOrBuilder

getCompanyName()

public String getCompanyName()

User job company name.

string company_name = 602;

Returns
Type Description
String

The companyName.

getCompanyNameBytes()

public ByteString getCompanyNameBytes()

User job company name.

string company_name = 602;

Returns
Type Description
ByteString

The bytes for companyName.

getDefaultInstanceForType()

public User getDefaultInstanceForType()
Returns
Type Description
User

getDepartment(int index)

public 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 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 int getDepartmentCount()

User job department

repeated string department = 603;

Returns
Type Description
int

The count of department.

getDepartmentList()

public ProtocolStringList getDepartmentList()

User job department

repeated string department = 603;

Returns
Type Description
ProtocolStringList

A list containing the department.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEmailAddresses(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the emailAddresses.

getEmployeeId()

public 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 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 String getFirstName()

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

string first_name = 100;

Returns
Type Description
String

The firstName.

getFirstNameBytes()

public ByteString getFirstNameBytes()

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

string first_name = 100;

Returns
Type Description
ByteString

The bytes for firstName.

getFirstSeenTime()

public 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.

getFirstSeenTimeBuilder()

public Timestamp.Builder getFirstSeenTimeBuilder()

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
Builder

getFirstSeenTimeOrBuilder()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the groupIdentifiers.

getGroupid() (deprecated)

public 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 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 Timestamp getHireDate()

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Returns
Type Description
Timestamp

The hireDate.

getHireDateBuilder()

public Timestamp.Builder getHireDateBuilder()

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Returns
Type Description
Builder

getHireDateOrBuilder()

public TimestampOrBuilder getHireDateOrBuilder()

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Returns
Type Description
TimestampOrBuilder

getLastBadPasswordAttemptTime()

public Timestamp getLastBadPasswordAttemptTime()

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Returns
Type Description
Timestamp

The lastBadPasswordAttemptTime.

getLastBadPasswordAttemptTimeBuilder()

public Timestamp.Builder getLastBadPasswordAttemptTimeBuilder()

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Returns
Type Description
Builder

getLastBadPasswordAttemptTimeOrBuilder()

public TimestampOrBuilder getLastBadPasswordAttemptTimeOrBuilder()

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Returns
Type Description
TimestampOrBuilder

getLastLoginTime()

public Timestamp getLastLoginTime()

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Returns
Type Description
Timestamp

The lastLoginTime.

getLastLoginTimeBuilder()

public Timestamp.Builder getLastLoginTimeBuilder()

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Returns
Type Description
Builder

getLastLoginTimeOrBuilder()

public TimestampOrBuilder getLastLoginTimeOrBuilder()

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Returns
Type Description
TimestampOrBuilder

getLastName()

public String getLastName()

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

string last_name = 102;

Returns
Type Description
String

The lastName.

getLastNameBytes()

public ByteString getLastNameBytes()

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

string last_name = 102;

Returns
Type Description
ByteString

The bytes for lastName.

getLastPasswordChangeTime()

public Timestamp getLastPasswordChangeTime()

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Returns
Type Description
Timestamp

The lastPasswordChangeTime.

getLastPasswordChangeTimeBuilder()

public Timestamp.Builder getLastPasswordChangeTimeBuilder()

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Returns
Type Description
Builder

getLastPasswordChangeTimeOrBuilder()

public TimestampOrBuilder getLastPasswordChangeTimeOrBuilder()

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Returns
Type Description
TimestampOrBuilder

getManagers(int index)

public User getManagers(int index)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name Description
index int
Returns
Type Description
User

getManagersBuilder(int index)

public User.Builder getManagersBuilder(int index)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name Description
index int
Returns
Type Description
User.Builder

getManagersBuilderList()

public List<User.Builder> getManagersBuilderList()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type Description
List<Builder>

getManagersCount()

public int getManagersCount()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type Description
int

getManagersList()

public List<User> getManagersList()

User job manager(s).

repeated .google.backstory.User managers = 605;

Returns
Type Description
List<User>

getManagersOrBuilder(int index)

public 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 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 String getMiddleName()

Middle name of the user.

string middle_name = 101;

Returns
Type Description
String

The middleName.

getMiddleNameBytes()

public ByteString getMiddleNameBytes()

Middle name of the user.

string middle_name = 101;

Returns
Type Description
ByteString

The bytes for middleName.

getOfficeAddress()

public Location getOfficeAddress()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type Description
Location

The officeAddress.

getOfficeAddressBuilder()

public Location.Builder getOfficeAddressBuilder()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type Description
Location.Builder

getOfficeAddressOrBuilder()

public LocationOrBuilder getOfficeAddressOrBuilder()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type Description
LocationOrBuilder

getPasswordExpirationTime()

public Timestamp getPasswordExpirationTime()

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Returns
Type Description
Timestamp

The passwordExpirationTime.

getPasswordExpirationTimeBuilder()

public Timestamp.Builder getPasswordExpirationTimeBuilder()

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Returns
Type Description
Builder

getPasswordExpirationTimeOrBuilder()

public TimestampOrBuilder getPasswordExpirationTimeOrBuilder()

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Returns
Type Description
TimestampOrBuilder

getPersonalAddress()

public Location getPersonalAddress()

Personal address of the user.

.google.backstory.Location personal_address = 104;

Returns
Type Description
Location

The personalAddress.

getPersonalAddressBuilder()

public Location.Builder getPersonalAddressBuilder()

Personal address of the user.

.google.backstory.Location personal_address = 104;

Returns
Type Description
Location.Builder

getPersonalAddressOrBuilder()

public LocationOrBuilder getPersonalAddressOrBuilder()

Personal address of the user.

.google.backstory.Location personal_address = 104;

Returns
Type Description
LocationOrBuilder

getPhoneNumbers(int index)

public 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 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 int getPhoneNumbersCount()

Phone numbers for the user.

repeated string phone_numbers = 103;

Returns
Type Description
int

The count of phoneNumbers.

getPhoneNumbersList()

public ProtocolStringList getPhoneNumbersList()

Phone numbers for the user.

repeated string phone_numbers = 103;

Returns
Type Description
ProtocolStringList

A list containing the phoneNumbers.

getProductObjectId()

public 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 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 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 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 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 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 Timestamp getTerminationDate()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type Description
Timestamp

The terminationDate.

getTerminationDateBuilder()

public Timestamp.Builder getTerminationDateBuilder()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type Description
Builder

getTerminationDateOrBuilder()

public TimestampOrBuilder getTerminationDateOrBuilder()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type Description
TimestampOrBuilder

getTimeOff(int index)

public 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

getTimeOffBuilder(int index)

public TimeOff.Builder getTimeOffBuilder(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.Builder

getTimeOffBuilderList()

public List<TimeOff.Builder> getTimeOffBuilderList()

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Returns
Type Description
List<Builder>

getTimeOffCount()

public int getTimeOffCount()

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Returns
Type Description
int

getTimeOffList()

public 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 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 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 String getTitle()

User job title.

string title = 601;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

User job title.

string title = 601;

Returns
Type Description
ByteString

The bytes for title.

getUserAuthenticationStatus()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 boolean hasOfficeAddress()

User job office location.

.google.backstory.Location office_address = 604;

Returns
Type Description
boolean

Whether the officeAddress field is set.

hasPasswordExpirationTime()

public 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 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 boolean hasTerminationDate()

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Returns
Type Description
boolean

Whether the terminationDate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAccountExpirationTime(Timestamp value)

public User.Builder mergeAccountExpirationTime(Timestamp value)

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergeAccountLockoutTime(Timestamp value)

public User.Builder mergeAccountLockoutTime(Timestamp value)

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergeAttribute(Attribute value)

public User.Builder mergeAttribute(Attribute value)

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Parameter
Name Description
value Attribute
Returns
Type Description
User.Builder

mergeFirstSeenTime(Timestamp value)

public User.Builder mergeFirstSeenTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergeFrom(User other)

public User.Builder mergeFrom(User other)
Parameter
Name Description
other User
Returns
Type Description
User.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public User.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public User.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
User.Builder
Overrides

mergeHireDate(Timestamp value)

public User.Builder mergeHireDate(Timestamp value)

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergeLastBadPasswordAttemptTime(Timestamp value)

public User.Builder mergeLastBadPasswordAttemptTime(Timestamp value)

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergeLastLoginTime(Timestamp value)

public User.Builder mergeLastLoginTime(Timestamp value)

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergeLastPasswordChangeTime(Timestamp value)

public User.Builder mergeLastPasswordChangeTime(Timestamp value)

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergeOfficeAddress(Location value)

public User.Builder mergeOfficeAddress(Location value)

User job office location.

.google.backstory.Location office_address = 604;

Parameter
Name Description
value Location
Returns
Type Description
User.Builder

mergePasswordExpirationTime(Timestamp value)

public User.Builder mergePasswordExpirationTime(Timestamp value)

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

mergePersonalAddress(Location value)

public User.Builder mergePersonalAddress(Location value)

Personal address of the user.

.google.backstory.Location personal_address = 104;

Parameter
Name Description
value Location
Returns
Type Description
User.Builder

mergeTerminationDate(Timestamp value)

public User.Builder mergeTerminationDate(Timestamp value)

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

removeManagers(int index)

public User.Builder removeManagers(int index)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameter
Name Description
index int
Returns
Type Description
User.Builder

removeTimeOff(int index)

public User.Builder removeTimeOff(int index)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameter
Name Description
index int
Returns
Type Description
User.Builder

setAccountExpirationTime(Timestamp value)

public User.Builder setAccountExpirationTime(Timestamp value)

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setAccountExpirationTime(Timestamp.Builder builderForValue)

public User.Builder setAccountExpirationTime(Timestamp.Builder builderForValue)

User account expiration timestamp.

.google.protobuf.Timestamp account_expiration_time = 612;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setAccountLockoutTime(Timestamp value)

public User.Builder setAccountLockoutTime(Timestamp value)

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setAccountLockoutTime(Timestamp.Builder builderForValue)

public User.Builder setAccountLockoutTime(Timestamp.Builder builderForValue)

User account lockout timestamp.

.google.protobuf.Timestamp account_lockout_time = 613;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setAccountType(User.AccountType value)

public User.Builder setAccountType(User.AccountType value)

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;

Parameter
Name Description
value User.AccountType

The accountType to set.

Returns
Type Description
User.Builder

This builder for chaining.

setAccountTypeValue(int value)

public User.Builder setAccountTypeValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for accountType to set.

Returns
Type Description
User.Builder

This builder for chaining.

setAttribute(Attribute value)

public User.Builder setAttribute(Attribute value)

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Parameter
Name Description
value Attribute
Returns
Type Description
User.Builder

setAttribute(Attribute.Builder builderForValue)

public User.Builder setAttribute(Attribute.Builder builderForValue)

Generic entity metadata attributes of the user.

.google.backstory.Attribute attribute = 8;

Parameter
Name Description
builderForValue Attribute.Builder
Returns
Type Description
User.Builder

setCompanyName(String value)

public User.Builder setCompanyName(String value)

User job company name.

string company_name = 602;

Parameter
Name Description
value String

The companyName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setCompanyNameBytes(ByteString value)

public User.Builder setCompanyNameBytes(ByteString value)

User job company name.

string company_name = 602;

Parameter
Name Description
value ByteString

The bytes for companyName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setDepartment(int index, String value)

public User.Builder setDepartment(int index, String value)

User job department

repeated string department = 603;

Parameters
Name Description
index int

The index to set the value at.

value String

The department to set.

Returns
Type Description
User.Builder

This builder for chaining.

setEmailAddresses(int index, String value)

public User.Builder setEmailAddresses(int index, String value)

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

repeated string email_addresses = 5;

Parameters
Name Description
index int

The index to set the value at.

value String

The emailAddresses to set.

Returns
Type Description
User.Builder

This builder for chaining.

setEmployeeId(String value)

public User.Builder setEmployeeId(String value)

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

string employee_id = 6;

Parameter
Name Description
value String

The employeeId to set.

Returns
Type Description
User.Builder

This builder for chaining.

setEmployeeIdBytes(ByteString value)

public User.Builder setEmployeeIdBytes(ByteString value)

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

string employee_id = 6;

Parameter
Name Description
value ByteString

The bytes for employeeId to set.

Returns
Type Description
User.Builder

This builder for chaining.

setFirstName(String value)

public User.Builder setFirstName(String value)

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

string first_name = 100;

Parameter
Name Description
value String

The firstName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setFirstNameBytes(ByteString value)

public User.Builder setFirstNameBytes(ByteString value)

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

string first_name = 100;

Parameter
Name Description
value ByteString

The bytes for firstName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setFirstSeenTime(Timestamp value)

public User.Builder setFirstSeenTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setFirstSeenTime(Timestamp.Builder builderForValue)

public User.Builder setFirstSeenTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setGroupIdentifiers(int index, String value)

public User.Builder setGroupIdentifiers(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The groupIdentifiers to set.

Returns
Type Description
User.Builder

This builder for chaining.

setGroupid(String value) (deprecated)

public User.Builder setGroupid(String value)

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];

Parameter
Name Description
value String

The groupid to set.

Returns
Type Description
User.Builder

This builder for chaining.

setGroupidBytes(ByteString value) (deprecated)

public User.Builder setGroupidBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for groupid to set.

Returns
Type Description
User.Builder

This builder for chaining.

setHireDate(Timestamp value)

public User.Builder setHireDate(Timestamp value)

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setHireDate(Timestamp.Builder builderForValue)

public User.Builder setHireDate(Timestamp.Builder builderForValue)

User job employment hire date.

.google.protobuf.Timestamp hire_date = 606;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setLastBadPasswordAttemptTime(Timestamp value)

public User.Builder setLastBadPasswordAttemptTime(Timestamp value)

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setLastBadPasswordAttemptTime(Timestamp.Builder builderForValue)

public User.Builder setLastBadPasswordAttemptTime(Timestamp.Builder builderForValue)

User last bad password attempt timestamp.

.google.protobuf.Timestamp last_bad_password_attempt_time = 614;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setLastLoginTime(Timestamp value)

public User.Builder setLastLoginTime(Timestamp value)

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setLastLoginTime(Timestamp.Builder builderForValue)

public User.Builder setLastLoginTime(Timestamp.Builder builderForValue)

User last login timestamp.

.google.protobuf.Timestamp last_login_time = 609;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setLastName(String value)

public User.Builder setLastName(String value)

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

string last_name = 102;

Parameter
Name Description
value String

The lastName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setLastNameBytes(ByteString value)

public User.Builder setLastNameBytes(ByteString value)

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

string last_name = 102;

Parameter
Name Description
value ByteString

The bytes for lastName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setLastPasswordChangeTime(Timestamp value)

public User.Builder setLastPasswordChangeTime(Timestamp value)

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setLastPasswordChangeTime(Timestamp.Builder builderForValue)

public User.Builder setLastPasswordChangeTime(Timestamp.Builder builderForValue)

User last password change timestamp.

.google.protobuf.Timestamp last_password_change_time = 610;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setManagers(int index, User value)

public User.Builder setManagers(int index, User value)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameters
Name Description
index int
value User
Returns
Type Description
User.Builder

setManagers(int index, User.Builder builderForValue)

public User.Builder setManagers(int index, User.Builder builderForValue)

User job manager(s).

repeated .google.backstory.User managers = 605;

Parameters
Name Description
index int
builderForValue User.Builder
Returns
Type Description
User.Builder

setMiddleName(String value)

public User.Builder setMiddleName(String value)

Middle name of the user.

string middle_name = 101;

Parameter
Name Description
value String

The middleName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setMiddleNameBytes(ByteString value)

public User.Builder setMiddleNameBytes(ByteString value)

Middle name of the user.

string middle_name = 101;

Parameter
Name Description
value ByteString

The bytes for middleName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setOfficeAddress(Location value)

public User.Builder setOfficeAddress(Location value)

User job office location.

.google.backstory.Location office_address = 604;

Parameter
Name Description
value Location
Returns
Type Description
User.Builder

setOfficeAddress(Location.Builder builderForValue)

public User.Builder setOfficeAddress(Location.Builder builderForValue)

User job office location.

.google.backstory.Location office_address = 604;

Parameter
Name Description
builderForValue Location.Builder
Returns
Type Description
User.Builder

setPasswordExpirationTime(Timestamp value)

public User.Builder setPasswordExpirationTime(Timestamp value)

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setPasswordExpirationTime(Timestamp.Builder builderForValue)

public User.Builder setPasswordExpirationTime(Timestamp.Builder builderForValue)

User password expiration timestamp.

.google.protobuf.Timestamp password_expiration_time = 611;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setPersonalAddress(Location value)

public User.Builder setPersonalAddress(Location value)

Personal address of the user.

.google.backstory.Location personal_address = 104;

Parameter
Name Description
value Location
Returns
Type Description
User.Builder

setPersonalAddress(Location.Builder builderForValue)

public User.Builder setPersonalAddress(Location.Builder builderForValue)

Personal address of the user.

.google.backstory.Location personal_address = 104;

Parameter
Name Description
builderForValue Location.Builder
Returns
Type Description
User.Builder

setPhoneNumbers(int index, String value)

public User.Builder setPhoneNumbers(int index, String value)

Phone numbers for the user.

repeated string phone_numbers = 103;

Parameters
Name Description
index int

The index to set the value at.

value String

The phoneNumbers to set.

Returns
Type Description
User.Builder

This builder for chaining.

setProductObjectId(String value)

public User.Builder setProductObjectId(String value)

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;

Parameter
Name Description
value String

The productObjectId to set.

Returns
Type Description
User.Builder

This builder for chaining.

setProductObjectIdBytes(ByteString value)

public User.Builder setProductObjectIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for productObjectId to set.

Returns
Type Description
User.Builder

This builder for chaining.

setRoleDescription(String value) (deprecated)

public User.Builder setRoleDescription(String value)

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];

Parameter
Name Description
value String

The roleDescription to set.

Returns
Type Description
User.Builder

This builder for chaining.

setRoleDescriptionBytes(ByteString value) (deprecated)

public User.Builder setRoleDescriptionBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for roleDescription to set.

Returns
Type Description
User.Builder

This builder for chaining.

setRoleName(String value) (deprecated)

public User.Builder setRoleName(String value)

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];

Parameter
Name Description
value String

The roleName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setRoleNameBytes(ByteString value) (deprecated)

public User.Builder setRoleNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for roleName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setTerminationDate(Timestamp value)

public User.Builder setTerminationDate(Timestamp value)

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Parameter
Name Description
value Timestamp
Returns
Type Description
User.Builder

setTerminationDate(Timestamp.Builder builderForValue)

public User.Builder setTerminationDate(Timestamp.Builder builderForValue)

User job employment termination date.

.google.protobuf.Timestamp termination_date = 607;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
User.Builder

setTimeOff(int index, TimeOff value)

public User.Builder setTimeOff(int index, TimeOff value)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameters
Name Description
index int
value TimeOff
Returns
Type Description
User.Builder

setTimeOff(int index, TimeOff.Builder builderForValue)

public User.Builder setTimeOff(int index, TimeOff.Builder builderForValue)

User time off leaves from active work.

repeated .google.backstory.TimeOff time_off = 608;

Parameters
Name Description
index int
builderForValue TimeOff.Builder
Returns
Type Description
User.Builder

setTitle(String value)

public User.Builder setTitle(String value)

User job title.

string title = 601;

Parameter
Name Description
value String

The title to set.

Returns
Type Description
User.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public User.Builder setTitleBytes(ByteString value)

User job title.

string title = 601;

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUserAuthenticationStatus(Authentication.AuthenticationStatus value)

public User.Builder setUserAuthenticationStatus(Authentication.AuthenticationStatus value)

System authentication status for user.

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

Parameter
Name Description
value Authentication.AuthenticationStatus

The userAuthenticationStatus to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUserAuthenticationStatusValue(int value)

public User.Builder setUserAuthenticationStatusValue(int value)

System authentication status for user.

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

Parameter
Name Description
value int

The enum numeric value on the wire for userAuthenticationStatus to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUserDisplayName(String value)

public User.Builder setUserDisplayName(String value)

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

string user_display_name = 3;

Parameter
Name Description
value String

The userDisplayName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUserDisplayNameBytes(ByteString value)

public User.Builder setUserDisplayNameBytes(ByteString value)

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

string user_display_name = 3;

Parameter
Name Description
value ByteString

The bytes for userDisplayName to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUserRole(User.Role value) (deprecated)

public User.Builder setUserRole(User.Role value)

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];

Parameter
Name Description
value User.Role

The userRole to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUserRoleValue(int value) (deprecated)

public User.Builder setUserRoleValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for userRole to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUserid(String value)

public User.Builder setUserid(String value)

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

string userid = 1;

Parameter
Name Description
value String

The userid to set.

Returns
Type Description
User.Builder

This builder for chaining.

setUseridBytes(ByteString value)

public User.Builder setUseridBytes(ByteString value)

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

string userid = 1;

Parameter
Name Description
value ByteString

The bytes for userid to set.

Returns
Type Description
User.Builder

This builder for chaining.

setWindowsSid(String value)

public User.Builder setWindowsSid(String value)

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

string windows_sid = 4;

Parameter
Name Description
value String

The windowsSid to set.

Returns
Type Description
User.Builder

This builder for chaining.

setWindowsSidBytes(ByteString value)

public User.Builder setWindowsSidBytes(ByteString value)

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

string windows_sid = 4;

Parameter
Name Description
value ByteString

The bytes for windowsSid to set.

Returns
Type Description
User.Builder

This builder for chaining.