user_stores

Creates, updates, deletes, gets or lists a user_stores resource.

Overview

Name	user_stores
Type	Resource
Id	google.discoveryengine.user_stores

Fields

The following fields are returned by SELECT queries:

projects_locations_user_stores_get

Name	Datatype	Description
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.
defaultLicenseConfig	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.
displayName	string	The display name of the User Store.
enableExpiredLicenseAutoUpdate	boolean	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.
enableLicenseAutoRegister	boolean	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_user_stores_get	select	projectsId, locationsId, userStoresId		Gets the User Store.
projects_locations_user_stores_create	insert	projectsId, locationsId	userStoreId	Creates a new User Store.
projects_locations_user_stores_patch	update	projectsId, locationsId, userStoresId	updateMask	Updates the User Store.
projects_locations_user_stores_batch_update_user_licenses	update	projectsId, locationsId, userStoresId		Updates the User License. This method is used for batch assign/unassign licenses to users.
projects_locations_user_stores_delete	delete	projectsId, locationsId, userStoresId		Deletes the User Store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
userStoresId	string
updateMask	string (google-fieldmask)
userStoreId	string

SELECT examples

projects_locations_user_stores_get

Gets the User Store.

SELECT
name,
defaultLicenseConfig,
displayName,
enableExpiredLicenseAutoUpdate,
enableLicenseAutoRegister
FROM google.discoveryengine.user_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND userStoresId = '{{ userStoresId }}' -- required
;

INSERT examples

projects_locations_user_stores_create

Creates a new User Store.

INSERT INTO google.discoveryengine.user_stores (
data__displayName,
data__defaultLicenseConfig,
data__enableLicenseAutoRegister,
data__enableExpiredLicenseAutoUpdate,
data__name,
projectsId,
locationsId,
userStoreId
)
SELECT 
'{{ displayName }}',
'{{ defaultLicenseConfig }}',
{{ enableLicenseAutoRegister }},
{{ enableExpiredLicenseAutoUpdate }},
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ userStoreId }}'
RETURNING
name,
defaultLicenseConfig,
displayName,
enableExpiredLicenseAutoUpdate,
enableLicenseAutoRegister
;

Manifest

# Description fields are for documentation purposes
- name: user_stores
  props:
    - name: projectsId
      value: string
      description: Required parameter for the user_stores resource.
    - name: locationsId
      value: string
      description: Required parameter for the user_stores resource.
    - name: displayName
      value: string
      description: >
        The display name of the User Store.
        
    - name: defaultLicenseConfig
      value: string
      description: >
        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.
        
    - name: enableLicenseAutoRegister
      value: boolean
      description: >
        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.
        
    - name: enableExpiredLicenseAutoUpdate
      value: boolean
      description: >
        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.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: userStoreId
      value: string

UPDATE examples

projects_locations_user_stores_patch

Updates the User Store.

UPDATE google.discoveryengine.user_stores
SET 
data__displayName = '{{ displayName }}',
data__defaultLicenseConfig = '{{ defaultLicenseConfig }}',
data__enableLicenseAutoRegister = {{ enableLicenseAutoRegister }},
data__enableExpiredLicenseAutoUpdate = {{ enableExpiredLicenseAutoUpdate }},
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND userStoresId = '{{ userStoresId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
defaultLicenseConfig,
displayName,
enableExpiredLicenseAutoUpdate,
enableLicenseAutoRegister;

projects_locations_user_stores_batch_update_user_licenses

Updates the User License. This method is used for batch assign/unassign licenses to users.

UPDATE google.discoveryengine.user_stores
SET 
data__inlineSource = '{{ inlineSource }}',
data__deleteUnassignedUserLicenses = {{ deleteUnassignedUserLicenses }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND userStoresId = '{{ userStoresId }}' --required
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_user_stores_delete

Deletes the User Store.

DELETE FROM google.discoveryengine.user_stores
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND userStoresId = '{{ userStoresId }}' --required
;