Package com.buildless

Interface TenantOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getActive()
    Whether this account is considered active.
    String
    getAuthId()
    Specifies the linked authorization tenant for this org tenant record.
    com.google.protobuf.ByteString
    getAuthIdBytes()
    Specifies the linked authorization tenant for this org tenant record.
    Tenant.TenantBranding
    getBranding()
    Customizes the Buildless UI with tenant colors, logos, icons, and so on.
    Tenant.TenantBrandingOrBuilder
    getBrandingOrBuilder()
    Customizes the Buildless UI with tenant colors, logos, icons, and so on.
    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
    getDirectoryOrgLive()
    Specifies this organization's ID for use with directory integrations; specifically, this ID is used for live sync of users, groups, and roles.
    com.google.protobuf.ByteString
    getDirectoryOrgLiveBytes()
    Specifies this organization's ID for use with directory integrations; specifically, this ID is used for live sync of users, groups, and roles.
    String
    getDirectoryOrgSandbox()
    Specifies this organization's ID for use with directory integrations; specifically, this ID is used for sandbox sync of users, groups, and roles (see `directory_org_live` for production use).
    com.google.protobuf.ByteString
    getDirectoryOrgSandboxBytes()
    Specifies this organization's ID for use with directory integrations; specifically, this ID is used for sandbox sync of users, groups, and roles (see `directory_org_live` for production use).
    String
    getDisplayName()
    Display name for this tenant.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Display name for this tenant.
    Tenant.TenantDomain
    getDomain(int index)
    Specifies custom domains which are linked to this tenant.
    int
    getDomainCount()
    Specifies custom domains which are linked to this tenant.
    List<Tenant.TenantDomain>
    getDomainList()
    Specifies custom domains which are linked to this tenant.
    Tenant.TenantDomainOrBuilder
    getDomainOrBuilder(int index)
    Specifies custom domains which are linked to this tenant.
    List<? extends Tenant.TenantDomainOrBuilder>
    getDomainOrBuilderList()
    Specifies custom domains which are linked to this tenant.
    Tenant.TenantKey
    getKey()
    Specifies the record key for this tenant, which includes all components of the tenant's primary key.
    Tenant.TenantKeyOrBuilder
    getKeyOrBuilder()
    Specifies the record key for this tenant, which includes all components of the tenant's primary key.
    String
    getLocale()
    Locale to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
    com.google.protobuf.ByteString
    getLocaleBytes()
    Locale to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
    String
    getName()
    Short-name for this tenant, which should be a string of length 2-32 characters.
    com.google.protobuf.ByteString
    getNameBytes()
    Short-name for this tenant, which should be a string of length 2-32 characters.
    TenantPlanInfo
    getPlan()
    Plan info for this tenant, indicating their main subscription level and additional add-on entitlements, if any.
    TenantPlanInfoOrBuilder
    getPlanOrBuilder()
    Plan info for this tenant, indicating their main subscription level and additional add-on entitlements, if any.
    RepositoryProvider
    getRepoProvider()
    Specifies the main repository provider for this tenant.
    String
    getRepoProviderOrg()
    Specifies the name of the organization in the context of their repository provider (for example, their GitHub org name).
    com.google.protobuf.ByteString
    getRepoProviderOrgBytes()
    Specifies the name of the organization in the context of their repository provider (for example, their GitHub org name).
    int
    getRepoProviderValue()
    Specifies the main repository provider for this tenant.
    String
    getSubscriptionId()
    ID generated for this tenant's active subscription by the billing system.
    com.google.protobuf.ByteString
    getSubscriptionIdBytes()
    ID generated for this tenant's active subscription by the billing system.
    boolean
    getSuspended()
    Flipped to `true` if an organization is scheduled for deletion, or if it has been suspended due to lack of payment or other administrative action.
    String
    getTimezone()
    Timezone to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
    com.google.protobuf.ByteString
    getTimezoneBytes()
    Timezone to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
    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
    getUuid()
    Specifies a unique ID for the tenant which is not shared publicly.
    com.google.protobuf.ByteString
    getUuidBytes()
    Specifies a unique ID for the tenant which is not shared publicly.
    boolean
    hasBranding()
    Customizes the Buildless UI with tenant colors, logos, icons, and so on.
    boolean
    hasCreatedAt()
    Timestamp indicating when this record was created.
    boolean
    hasKey()
    Specifies the record key for this tenant, which includes all components of the tenant's primary key.
    boolean
    hasPlan()
    Plan info for this tenant, 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 the record key for this tenant, which includes all components of the tenant's primary key.
      .buildless.Tenant.TenantKey key = 1 [json_name = "key", (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.elide.model.field) = { ... }
      Returns:
      Whether the key field is set.

    • getKey

      Tenant.TenantKey getKey()
       Specifies the record key for this tenant, which includes all components of the tenant's primary key.
      .buildless.Tenant.TenantKey key = 1 [json_name = "key", (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.elide.model.field) = { ... }
      Returns:
      The key.

    • getKeyOrBuilder

      Tenant.TenantKeyOrBuilder getKeyOrBuilder()
       Specifies the record key for this tenant, which includes all components of the tenant's primary key.
      .buildless.Tenant.TenantKey key = 1 [json_name = "key", (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.elide.model.field) = { ... }

    • getUuid

      String getUuid()
       Specifies a unique ID for the tenant which is not shared publicly. This tenant UUID value is used to tie a tenant
 record to external management and billing systems. The Tenant UUID is not sensitive, but is considered internal.
 The Tenant UUID is globally unique.
      string uuid = 2 [json_name = "uuid", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The uuid.

    • getUuidBytes

      com.google.protobuf.ByteString getUuidBytes()
       Specifies a unique ID for the tenant which is not shared publicly. This tenant UUID value is used to tie a tenant
 record to external management and billing systems. The Tenant UUID is not sensitive, but is considered internal.
 The Tenant UUID is globally unique.
      string uuid = 2 [json_name = "uuid", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uuid.

    • getName

      String getName()
       Short-name for this tenant, which should be a string of length 2-32 characters. The name is also referred to as the
 "short name." This name is used in sub-domains, so it must be a DNS-compatible name. Globally unique.
      string name = 3 [json_name = "name", (.google.api.field_behavior) = IMMUTABLE, (.validate.rules) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Short-name for this tenant, which should be a string of length 2-32 characters. The name is also referred to as the
 "short name." This name is used in sub-domains, so it must be a DNS-compatible name. Globally unique.
      string name = 3 [json_name = "name", (.google.api.field_behavior) = IMMUTABLE, (.validate.rules) = { ... }
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Display name for this tenant. Can be any string value between 2-32 characters. The label is shown in user-facing
 interfaces to identify a given tenant account.
      string display_name = 4 [json_name = "displayName", (.validate.rules) = { ... }
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Display name for this tenant. Can be any string value between 2-32 characters. The label is shown in user-facing
 interfaces to identify a given tenant account.
      string display_name = 4 [json_name = "displayName", (.validate.rules) = { ... }
      Returns:
      The bytes for displayName.

    • getActive

      boolean getActive()
       Whether this account is considered active. If an account is inactive, users and resources associated with the
 tenant are not accessible. Inactive accounts are scheduled for deletion after a period of time.
      bool active = 5 [json_name = "active", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The active.

    • hasBranding

      boolean hasBranding()
       Customizes the Buildless UI with tenant colors, logos, icons, and so on. Optional. Only present for tenants which
 have a supporting plan and choose to customize branding.
      .buildless.Tenant.TenantBranding branding = 6 [json_name = "branding", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the branding field is set.

    • getBranding

      Tenant.TenantBranding getBranding()
       Customizes the Buildless UI with tenant colors, logos, icons, and so on. Optional. Only present for tenants which
 have a supporting plan and choose to customize branding.
      .buildless.Tenant.TenantBranding branding = 6 [json_name = "branding", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The branding.

    • getBrandingOrBuilder

      Tenant.TenantBrandingOrBuilder getBrandingOrBuilder()
       Customizes the Buildless UI with tenant colors, logos, icons, and so on. Optional. Only present for tenants which
 have a supporting plan and choose to customize branding.
      .buildless.Tenant.TenantBranding branding = 6 [json_name = "branding", (.google.api.field_behavior) = OPTIONAL];

    • getDomainList

      List<Tenant.TenantDomain> getDomainList()
       Specifies custom domains which are linked to this tenant. These records are only present if the tenant has chosen
 to link domains, and if their plan supports it.
      repeated .buildless.Tenant.TenantDomain domain = 7 [json_name = "domain", (.elide.model.collection) = { ... }

    • getDomain

      Tenant.TenantDomain getDomain(int index)
       Specifies custom domains which are linked to this tenant. These records are only present if the tenant has chosen
 to link domains, and if their plan supports it.
      repeated .buildless.Tenant.TenantDomain domain = 7 [json_name = "domain", (.elide.model.collection) = { ... }

    • getDomainCount

      int getDomainCount()
       Specifies custom domains which are linked to this tenant. These records are only present if the tenant has chosen
 to link domains, and if their plan supports it.
      repeated .buildless.Tenant.TenantDomain domain = 7 [json_name = "domain", (.elide.model.collection) = { ... }

    • getDomainOrBuilderList

      List<? extends Tenant.TenantDomainOrBuilder> getDomainOrBuilderList()
       Specifies custom domains which are linked to this tenant. These records are only present if the tenant has chosen
 to link domains, and if their plan supports it.
      repeated .buildless.Tenant.TenantDomain domain = 7 [json_name = "domain", (.elide.model.collection) = { ... }

    • getDomainOrBuilder

      Tenant.TenantDomainOrBuilder getDomainOrBuilder(int index)
       Specifies custom domains which are linked to this tenant. These records are only present if the tenant has chosen
 to link domains, and if their plan supports it.
      repeated .buildless.Tenant.TenantDomain domain = 7 [json_name = "domain", (.elide.model.collection) = { ... }

    • hasPlan

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

    • getPlan

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

    • getPlanOrBuilder

      TenantPlanInfoOrBuilder getPlanOrBuilder()
       Plan info for this tenant, indicating their main subscription level and additional add-on entitlements, if any.
      .buildless.billing.TenantPlanInfo plan = 8 [json_name = "plan", (.google.api.field_behavior) = OUTPUT_ONLY];

    • getAuthId

      String getAuthId()
       Specifies the linked authorization tenant for this org tenant record. The authorization tenant holds users and
 roles for a given tenant record.
      string auth_id = 9 [json_name = "authId", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The authId.

    • getAuthIdBytes

      com.google.protobuf.ByteString getAuthIdBytes()
       Specifies the linked authorization tenant for this org tenant record. The authorization tenant holds users and
 roles for a given tenant record.
      string auth_id = 9 [json_name = "authId", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for authId.

    • getRepoProviderValue

      int getRepoProviderValue()
       Specifies the main repository provider for this tenant. This is mostly a cosmetic setting, but it also governs
 which repositories are shown by default as options to add in the UI.
      .buildless.code.RepositoryProvider repo_provider = 10 [json_name = "repoProvider"];
      Returns:
      The enum numeric value on the wire for repoProvider.

    • getRepoProvider

      RepositoryProvider getRepoProvider()
       Specifies the main repository provider for this tenant. This is mostly a cosmetic setting, but it also governs
 which repositories are shown by default as options to add in the UI.
      .buildless.code.RepositoryProvider repo_provider = 10 [json_name = "repoProvider"];
      Returns:
      The repoProvider.

    • getRepoProviderOrg

      String getRepoProviderOrg()
       Specifies the name of the organization in the context of their repository provider (for example, their GitHub org
 name). This is both used cosmetically in the UI and used as a hint for repository discovery.
      string repo_provider_org = 11 [json_name = "repoProviderOrg", (.validate.rules) = { ... }
      Returns:
      The repoProviderOrg.

    • getRepoProviderOrgBytes

      com.google.protobuf.ByteString getRepoProviderOrgBytes()
       Specifies the name of the organization in the context of their repository provider (for example, their GitHub org
 name). This is both used cosmetically in the UI and used as a hint for repository discovery.
      string repo_provider_org = 11 [json_name = "repoProviderOrg", (.validate.rules) = { ... }
      Returns:
      The bytes for repoProviderOrg.

    • getSuspended

      boolean getSuspended()
       Flipped to `true` if an organization is scheduled for deletion, or if it has been suspended due to lack of payment
 or other administrative action. In this case, `active` will be set to `false`.
      bool suspended = 12 [json_name = "suspended", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The suspended.

    • getDirectoryOrgLive

      String getDirectoryOrgLive()
       Specifies this organization's ID for use with directory integrations; specifically, this ID is used for live sync
 of users, groups, and roles. Other features such as Log Streaming may also leverage this ID.
      string directory_org_live = 13 [json_name = "directoryOrgLive", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The directoryOrgLive.

    • getDirectoryOrgLiveBytes

      com.google.protobuf.ByteString getDirectoryOrgLiveBytes()
       Specifies this organization's ID for use with directory integrations; specifically, this ID is used for live sync
 of users, groups, and roles. Other features such as Log Streaming may also leverage this ID.
      string directory_org_live = 13 [json_name = "directoryOrgLive", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for directoryOrgLive.

    • getDirectoryOrgSandbox

      String getDirectoryOrgSandbox()
       Specifies this organization's ID for use with directory integrations; specifically, this ID is used for sandbox
 sync of users, groups, and roles (see `directory_org_live` for production use). Other features such as Log
 Streaming may also leverage this ID.
      string directory_org_sandbox = 14 [json_name = "directoryOrgSandbox", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The directoryOrgSandbox.

    • getDirectoryOrgSandboxBytes

      com.google.protobuf.ByteString getDirectoryOrgSandboxBytes()
       Specifies this organization's ID for use with directory integrations; specifically, this ID is used for sandbox
 sync of users, groups, and roles (see `directory_org_live` for production use). Other features such as Log
 Streaming may also leverage this ID.
      string directory_org_sandbox = 14 [json_name = "directoryOrgSandbox", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for directoryOrgSandbox.

    • getSubscriptionId

      String getSubscriptionId()
       ID generated for this tenant's active subscription by the billing system. This ID is always present for active
 (non-suspended) tenants.
      string subscription_id = 15 [json_name = "subscriptionId", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The subscriptionId.

    • getSubscriptionIdBytes

      com.google.protobuf.ByteString getSubscriptionIdBytes()
       ID generated for this tenant's active subscription by the billing system. This ID is always present for active
 (non-suspended) tenants.
      string subscription_id = 15 [json_name = "subscriptionId", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for subscriptionId.

    • getLocale

      String getLocale()
       Locale to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
      string locale = 16 [json_name = "locale", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The locale.

    • getLocaleBytes

      com.google.protobuf.ByteString getLocaleBytes()
       Locale to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
      string locale = 16 [json_name = "locale", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for locale.

    • getTimezone

      String getTimezone()
       Timezone to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
      string timezone = 17 [json_name = "timezone", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The timezone.

    • getTimezoneBytes

      com.google.protobuf.ByteString getTimezoneBytes()
       Timezone to default to for users who are managed by this tenant, and for tenant-level settings, UI, and operations.
      string timezone = 17 [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) = { ... }