public sealed class UserStore : IMessage<UserStore>, IEquatable<UserStore>, IDeepCloneable<UserStore>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1beta API class UserStore.
Configures metadata that is used for End User entities.
Implements
IMessageUserStore, IEquatableUserStore, IDeepCloneableUserStore, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.dll
Constructors
UserStore()
public UserStore()UserStore(UserStore)
public UserStore(UserStore other)| Parameter | |
|---|---|
| Name | Description |
other |
UserStore |
Properties
DefaultLicenseConfig
public string DefaultLicenseConfig { get; set; }Optional. The default subscription [LicenseConfig][google.cloud.discoveryengine.v1beta.LicenseConfig] for the UserStore, if [UserStore.enable_license_auto_register][google.cloud.discoveryengine.v1beta.UserStore.enable_license_auto_register] is true, new users will automatically register under the default subscription.
If default
[LicenseConfig][google.cloud.discoveryengine.v1beta.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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DefaultLicenseConfigAsLicenseConfigName
public LicenseConfigName DefaultLicenseConfigAsLicenseConfigName { get; set; }LicenseConfigName-typed view over the DefaultLicenseConfig resource name property.
| Property Value | |
|---|---|
| Type | Description |
LicenseConfigName |
|
DisplayName
public string DisplayName { get; set; }The display name of the User Store.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EnableExpiredLicenseAutoUpdate
public bool EnableExpiredLicenseAutoUpdate { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
EnableLicenseAutoRegister
public bool EnableLicenseAutoRegister { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UserStoreName
public UserStoreName UserStoreName { get; set; }UserStoreName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
UserStoreName |
|