Google Cloud Discovery Engine V1 Client - Class UserStore (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UserStore.

Configures metadata that is used for End User entities.

Generated from protobuf message google.cloud.discoveryengine.v1.UserStore

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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.

↳ display_name string

The display name of the User Store.

↳ default_license_config string

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.

↳ enable_license_auto_register bool

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.

↳ enable_expired_license_auto_update bool

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.

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

The display name of the User Store.

Returns
Type Description
string

setDisplayName

The display name of the User Store.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setDefaultLicenseConfig

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
bool

setEnableLicenseAutoRegister

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

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.

Returns
Type Description
bool

setEnableExpiredLicenseAutoUpdate

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.

Parameter
Name Description
var bool
Returns
Type Description
$this