Package com.buildless

Interface UserOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
User, User.Builder
public interface UserOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getActive()
    Specifies whether this user account is "active." This field summarizes all relevant inputs, such as the `suspended` field.
    boolean
    getArchived()
    Flipped to `true` if an organization admin archives a managed account.
    com.google.protobuf.Timestamp
    getCreatedAt()
    Timestamp indicating when this record was created.
    com.google.protobuf.TimestampOrBuilder
    getCreatedAtOrBuilder()
    Timestamp indicating when this record was created.
    String
    getDefaultTenant()
    Default tenant name which this user has elected to show upon log-in.
    com.google.protobuf.ByteString
    getDefaultTenantBytes()
    Default tenant name which this user has elected to show upon log-in.
    User.EmailAddress
    getEmail(int index)
    Specifies the email addresses linked to this user's account.
    int
    getEmailCount()
    Specifies the email addresses linked to this user's account.
    List<User.EmailAddress>
    getEmailList()
    Specifies the email addresses linked to this user's account.
    User.EmailAddressOrBuilder
    getEmailOrBuilder(int index)
    Specifies the email addresses linked to this user's account.
    List<? extends User.EmailAddressOrBuilder>
    getEmailOrBuilderList()
    Specifies the email addresses linked to this user's account.
    User.UserKey
    getKey()
    Specifies a unique text ID which identifies this user globally.
    User.UserKeyOrBuilder
    getKeyOrBuilder()
    Specifies a unique text ID which identifies this user globally.
    String
    getLink()
    Specifies a link to this user's profile, if available.
    com.google.protobuf.ByteString
    getLinkBytes()
    Specifies a link to this user's profile, if available.
    String
    getLocale()
    Locale override for this user.
    com.google.protobuf.ByteString
    getLocaleBytes()
    Locale override for this user.
    boolean
    getManaged()
    Specifies whether this user is managed by an enterprise directory.
    User.Name
    getName()
    Specifies naming information for this user, including their given name, family name, and display name.
    User.NameOrBuilder
    getNameOrBuilder()
    Specifies naming information for this user, including their given name, family name, and display name.
    String
    getPhoneNumber()
    Phone number for this user, if known and if provided.
    com.google.protobuf.ByteString
    getPhoneNumberBytes()
    Phone number for this user, if known and if provided.
    boolean
    getPhoneVerified()
    Indicates whether the user has verified their phone number, via a one-time SMS message.
    String
    getPicture()
    Specifies a link to the user's avatar, or profile picture.
    com.google.protobuf.ByteString
    getPictureBytes()
    Specifies a link to the user's avatar, or profile picture.
    IndividualPlanInfo
    getPlan()
    Plan info for this individual account, as applicable, indicating their main subscription level and additional add-on entitlements, if any.
    IndividualPlanInfoOrBuilder
    getPlanOrBuilder()
    Plan info for this individual account, as applicable, indicating their main subscription level and additional add-on entitlements, if any.
    AccountProvider
    getProvider()
    Specifies the host or provider of this account.
    int
    getProviderValue()
    Specifies the host or provider of this account.
    String
    getSubscriptionId()
    ID generated for this user's active individual subscription by the billing system.
    com.google.protobuf.ByteString
    getSubscriptionIdBytes()
    ID generated for this user's active individual subscription by the billing system.
    boolean
    getSuspended()
    Specifies whether this user account is suspended from access.
    String
    getTimezone()
    Timezone override for this user.
    com.google.protobuf.ByteString
    getTimezoneBytes()
    Timezone override for this user.
    com.google.protobuf.Timestamp
    getUpdatedAt()
    Timestamp indicating when this record was last updated.
    com.google.protobuf.TimestampOrBuilder
    getUpdatedAtOrBuilder()
    Timestamp indicating when this record was last updated.
    String
    getUsername()
    Specifies this user's display username, which may be changed by the user or populated from source control platforms such as GitHub.
    com.google.protobuf.ByteString
    getUsernameBytes()
    Specifies this user's display username, which may be changed by the user or populated from source control platforms such as GitHub.
    boolean
    hasCreatedAt()
    Timestamp indicating when this record was created.
    boolean
    hasKey()
    Specifies a unique text ID which identifies this user globally.
    boolean
    hasName()
    Specifies naming information for this user, including their given name, family name, and display name.
    boolean
    hasPlan()
    Plan info for this individual account, as applicable, indicating their main subscription level and additional add-on entitlements, if any.
    boolean
    hasUpdatedAt()
    Timestamp indicating when this record was last updated.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasKey

      boolean hasKey()
       Specifies a unique text ID which identifies this user globally. This value is generated by the auth engine used by
 Buildless and is considered immutable for the entire lifecycle of a user account. The ID mentions the identity
 provider which was used to establish the account, and is enforced for global uniqueness.
      .buildless.User.UserKey key = 1 [json_name = "key", (.elide.model.field) = { ... }
      Returns:
      Whether the key field is set.

    • getKey

      User.UserKey getKey()
       Specifies a unique text ID which identifies this user globally. This value is generated by the auth engine used by
 Buildless and is considered immutable for the entire lifecycle of a user account. The ID mentions the identity
 provider which was used to establish the account, and is enforced for global uniqueness.
      .buildless.User.UserKey key = 1 [json_name = "key", (.elide.model.field) = { ... }
      Returns:
      The key.

    • getKeyOrBuilder

      User.UserKeyOrBuilder getKeyOrBuilder()
       Specifies a unique text ID which identifies this user globally. This value is generated by the auth engine used by
 Buildless and is considered immutable for the entire lifecycle of a user account. The ID mentions the identity
 provider which was used to establish the account, and is enforced for global uniqueness.
      .buildless.User.UserKey key = 1 [json_name = "key", (.elide.model.field) = { ... }

    • getUsername

      String getUsername()
       Specifies this user's display username, which may be changed by the user or populated from source control platforms
 such as GitHub. This value is not guaranteed to be globally unique, and must consist of only alphanumeric
 characters, with a length between 2-32 characters.
      string username = 2 [json_name = "username", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The username.

    • getUsernameBytes

      com.google.protobuf.ByteString getUsernameBytes()
       Specifies this user's display username, which may be changed by the user or populated from source control platforms
 such as GitHub. This value is not guaranteed to be globally unique, and must consist of only alphanumeric
 characters, with a length between 2-32 characters.
      string username = 2 [json_name = "username", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for username.

    • hasName

      boolean hasName()
       Specifies naming information for this user, including their given name, family name, and display name. The display
 name should be used in UI circumstances. In some contexts, only the display name may be returned.
      .buildless.User.Name name = 3 [json_name = "name"];
      Returns:
      Whether the name field is set.

    • getName

      User.Name getName()
       Specifies naming information for this user, including their given name, family name, and display name. The display
 name should be used in UI circumstances. In some contexts, only the display name may be returned.
      .buildless.User.Name name = 3 [json_name = "name"];
      Returns:
      The name.

    • getNameOrBuilder

      User.NameOrBuilder getNameOrBuilder()
       Specifies naming information for this user, including their given name, family name, and display name. The display
 name should be used in UI circumstances. In some contexts, only the display name may be returned.
      .buildless.User.Name name = 3 [json_name = "name"];

    • getEmailList

      List<User.EmailAddress> getEmailList()
       Specifies the email addresses linked to this user's account. Each email address is expressed, along with that
 address' `primary` or `verified` status. Only one email address may be marked as `primary`. Primary email entries
 must be `verified`. All user accounts require at least one `primary` email address at this time.
      repeated .buildless.User.EmailAddress email = 4 [json_name = "email"];

    • getEmail

      User.EmailAddress getEmail(int index)
       Specifies the email addresses linked to this user's account. Each email address is expressed, along with that
 address' `primary` or `verified` status. Only one email address may be marked as `primary`. Primary email entries
 must be `verified`. All user accounts require at least one `primary` email address at this time.
      repeated .buildless.User.EmailAddress email = 4 [json_name = "email"];

    • getEmailCount

      int getEmailCount()
       Specifies the email addresses linked to this user's account. Each email address is expressed, along with that
 address' `primary` or `verified` status. Only one email address may be marked as `primary`. Primary email entries
 must be `verified`. All user accounts require at least one `primary` email address at this time.
      repeated .buildless.User.EmailAddress email = 4 [json_name = "email"];

    • getEmailOrBuilderList

      List<? extends User.EmailAddressOrBuilder> getEmailOrBuilderList()
       Specifies the email addresses linked to this user's account. Each email address is expressed, along with that
 address' `primary` or `verified` status. Only one email address may be marked as `primary`. Primary email entries
 must be `verified`. All user accounts require at least one `primary` email address at this time.
      repeated .buildless.User.EmailAddress email = 4 [json_name = "email"];

    • getEmailOrBuilder

      User.EmailAddressOrBuilder getEmailOrBuilder(int index)
       Specifies the email addresses linked to this user's account. Each email address is expressed, along with that
 address' `primary` or `verified` status. Only one email address may be marked as `primary`. Primary email entries
 must be `verified`. All user accounts require at least one `primary` email address at this time.
      repeated .buildless.User.EmailAddress email = 4 [json_name = "email"];

    • hasPlan

      boolean hasPlan()
       Plan info for this individual account, as applicable, indicating their main subscription level and additional
 add-on entitlements, if any.
      .buildless.billing.IndividualPlanInfo plan = 5 [json_name = "plan", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the plan field is set.

    • getPlan

      IndividualPlanInfo getPlan()
       Plan info for this individual account, as applicable, indicating their main subscription level and additional
 add-on entitlements, if any.
      .buildless.billing.IndividualPlanInfo plan = 5 [json_name = "plan", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The plan.

    • getPlanOrBuilder

      IndividualPlanInfoOrBuilder getPlanOrBuilder()
       Plan info for this individual account, as applicable, indicating their main subscription level and additional
 add-on entitlements, if any.
      .buildless.billing.IndividualPlanInfo plan = 5 [json_name = "plan", (.google.api.field_behavior) = OUTPUT_ONLY];

    • getPhoneNumber

      String getPhoneNumber()
       Phone number for this user, if known and if provided. This number may be used for urgent SMS communications, such
 as 2FA verifications at login.
      string phone_number = 6 [json_name = "phoneNumber", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The phoneNumber.

    • getPhoneNumberBytes

      com.google.protobuf.ByteString getPhoneNumberBytes()
       Phone number for this user, if known and if provided. This number may be used for urgent SMS communications, such
 as 2FA verifications at login.
      string phone_number = 6 [json_name = "phoneNumber", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for phoneNumber.

    • getPhoneVerified

      boolean getPhoneVerified()
       Indicates whether the user has verified their phone number, via a one-time SMS message.
      bool phone_verified = 7 [json_name = "phoneVerified", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The phoneVerified.

    • getProviderValue

      int getProviderValue()
       Specifies the host or provider of this account. This value indicates the provider for the main account identity,
 and may not represent the full set of providers for the user.
      .buildless.AccountProvider provider = 8 [json_name = "provider", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for provider.

    • getProvider

      AccountProvider getProvider()
       Specifies the host or provider of this account. This value indicates the provider for the main account identity,
 and may not represent the full set of providers for the user.
      .buildless.AccountProvider provider = 8 [json_name = "provider", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The provider.

    • getPicture

      String getPicture()
       Specifies a link to the user's avatar, or profile picture. This value is optional and may be null.
      string picture = 9 [json_name = "picture", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The picture.

    • getPictureBytes

      com.google.protobuf.ByteString getPictureBytes()
       Specifies a link to the user's avatar, or profile picture. This value is optional and may be null.
      string picture = 9 [json_name = "picture", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for picture.

    • getLink

      String getLink()
       Specifies a link to this user's profile, if available. This is often the user's social or GitHub profile, but may
 also be a work-related link for Enterprise users, like to their Slack profile.
      string link = 10 [json_name = "link", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The link.

    • getLinkBytes

      com.google.protobuf.ByteString getLinkBytes()
       Specifies a link to this user's profile, if available. This is often the user's social or GitHub profile, but may
 also be a work-related link for Enterprise users, like to their Slack profile.
      string link = 10 [json_name = "link", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for link.

    • getManaged

      boolean getManaged()
       Specifies whether this user is managed by an enterprise directory.
      bool managed = 11 [json_name = "managed", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The managed.

    • getSuspended

      boolean getSuspended()
       Specifies whether this user account is suspended from access.
      bool suspended = 12 [json_name = "suspended", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The suspended.

    • getActive

      boolean getActive()
       Specifies whether this user account is "active." This field summarizes all relevant inputs, such as the `suspended`
 field. If `false`, the user account is considered "inactive" and will be denied access to all resources.
      bool active = 13 [json_name = "active", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The active.

    • getArchived

      boolean getArchived()
       Flipped to `true` if an organization admin archives a managed account. Only applicable if `managed` is active for a
 given user profile and license seat.
      bool archived = 14 [json_name = "archived", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The archived.

    • getDefaultTenant

      String getDefaultTenant()
       Default tenant name which this user has elected to show upon log-in. The active tenant can be changed via the UI,
 so this is merely a hint about which tenant to select first if the user has access to multiple tenants.
      string default_tenant = 15 [json_name = "defaultTenant", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The defaultTenant.

    • getDefaultTenantBytes

      com.google.protobuf.ByteString getDefaultTenantBytes()
       Default tenant name which this user has elected to show upon log-in. The active tenant can be changed via the UI,
 so this is merely a hint about which tenant to select first if the user has access to multiple tenants.
      string default_tenant = 15 [json_name = "defaultTenant", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for defaultTenant.

    • getSubscriptionId

      String getSubscriptionId()
       ID generated for this user's active individual subscription by the billing system. This ID is only present for
 active (non-suspended) accounts which have an individual subscription plan. Managed and tenant-associated users do
 not have a value present in this field.
      string subscription_id = 16 [json_name = "subscriptionId", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The subscriptionId.

    • getSubscriptionIdBytes

      com.google.protobuf.ByteString getSubscriptionIdBytes()
       ID generated for this user's active individual subscription by the billing system. This ID is only present for
 active (non-suspended) accounts which have an individual subscription plan. Managed and tenant-associated users do
 not have a value present in this field.
      string subscription_id = 16 [json_name = "subscriptionId", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for subscriptionId.

    • getLocale

      String getLocale()
       Locale override for this user. This value replaces whatever default is set for the tenant. If no value is present,
 a value is resolved from the session; failing that, the value `en-US` is used by default.
      string locale = 17 [json_name = "locale", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The locale.

    • getLocaleBytes

      com.google.protobuf.ByteString getLocaleBytes()
       Locale override for this user. This value replaces whatever default is set for the tenant. If no value is present,
 a value is resolved from the session; failing that, the value `en-US` is used by default.
      string locale = 17 [json_name = "locale", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for locale.

    • getTimezone

      String getTimezone()
       Timezone override for this user. This value replaces whatever default is set for the tenant. If no value is
 present, a value is resolved from the session; failing that, the value `UTC` is used by default.
      string timezone = 18 [json_name = "timezone", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The timezone.

    • getTimezoneBytes

      com.google.protobuf.ByteString getTimezoneBytes()
       Timezone override for this user. This value replaces whatever default is set for the tenant. If no value is
 present, a value is resolved from the session; failing that, the value `UTC` is used by default.
      string timezone = 18 [json_name = "timezone", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for timezone.

    • hasUpdatedAt

      boolean hasUpdatedAt()
       Timestamp indicating when this record was last updated. Any update to the tenant results in an update to this
 timestamp field. At first creation, this value should be equal to the value held by `created_at`.
      .google.protobuf.Timestamp updated_at = 98 [json_name = "updatedAt", (.elide.model.field) = { ... }
      Returns:
      Whether the updatedAt field is set.

    • getUpdatedAt

      com.google.protobuf.Timestamp getUpdatedAt()
       Timestamp indicating when this record was last updated. Any update to the tenant results in an update to this
 timestamp field. At first creation, this value should be equal to the value held by `created_at`.
      .google.protobuf.Timestamp updated_at = 98 [json_name = "updatedAt", (.elide.model.field) = { ... }
      Returns:
      The updatedAt.

    • getUpdatedAtOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdatedAtOrBuilder()
       Timestamp indicating when this record was last updated. Any update to the tenant results in an update to this
 timestamp field. At first creation, this value should be equal to the value held by `created_at`.
      .google.protobuf.Timestamp updated_at = 98 [json_name = "updatedAt", (.elide.model.field) = { ... }

    • hasCreatedAt

      boolean hasCreatedAt()
       Timestamp indicating when this record was created. Any update to the tenant results in an update to this timestamp
 field. This value is populated if a record has been stored, and is empty if a record has not yet been stored.
      .google.protobuf.Timestamp created_at = 99 [json_name = "createdAt", (.elide.model.field) = { ... }
      Returns:
      Whether the createdAt field is set.

    • getCreatedAt

      com.google.protobuf.Timestamp getCreatedAt()
       Timestamp indicating when this record was created. Any update to the tenant results in an update to this timestamp
 field. This value is populated if a record has been stored, and is empty if a record has not yet been stored.
      .google.protobuf.Timestamp created_at = 99 [json_name = "createdAt", (.elide.model.field) = { ... }
      Returns:
      The createdAt.

    • getCreatedAtOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder()
       Timestamp indicating when this record was created. Any update to the tenant results in an update to this timestamp
 field. This value is populated if a record has been stored, and is empty if a record has not yet been stored.
      .google.protobuf.Timestamp created_at = 99 [json_name = "createdAt", (.elide.model.field) = { ... }