public interface UserStoreOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDefaultLicenseConfig()
public abstract String getDefaultLicenseConfig()Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription.
If default
LicenseConfig doesn't
have remaining license seats left, new users will not be assigned with
license and will be blocked for Vertex AI Search features. This is used if
license_assignment_tier_rules is not configured.
string default_license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The defaultLicenseConfig. |
getDefaultLicenseConfigBytes()
public abstract ByteString getDefaultLicenseConfigBytes()Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription.
If default
LicenseConfig doesn't
have remaining license seats left, new users will not be assigned with
license and will be blocked for Vertex AI Search features. This is used if
license_assignment_tier_rules is not configured.
string default_license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultLicenseConfig. |
getDisplayName()
public abstract String getDisplayName()The display name of the User Store.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()The display name of the User Store.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEnableExpiredLicenseAutoUpdate()
public abstract boolean getEnableExpiredLicenseAutoUpdate()Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
bool enable_expired_license_auto_update = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableExpiredLicenseAutoUpdate. |
getEnableLicenseAutoRegister()
public abstract boolean getEnableLicenseAutoRegister()Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
bool enable_license_auto_register = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableLicenseAutoRegister. |
getName()
public abstract String getName() Immutable. The full resource name of the User Store, in the format of
projects/{project}/locations/{location}/userStores/{user_store}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Immutable. The full resource name of the User Store, in the format of
projects/{project}/locations/{location}/userStores/{user_store}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |