license_configs

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

Overview

Name	license_configs
Type	Resource
Id	google.discoveryengine.license_configs

Fields

The following fields are returned by SELECT queries:

projects_locations_license_configs_get

Name	Datatype	Description
name	string	Immutable. Identifier. The fully qualified resource name of the license config. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}
autoRenew	boolean	Optional. Whether the license config should be auto renewed when it reaches the end date.
endDate	object	Optional. The planed end date. (id: GoogleTypeDate)
freeTrial	boolean	Optional. Whether the license config is for free trial.
geminiBundle	boolean	Output only. Whether the license config is for Gemini bundle.
licenseCount	string (int64)	Required. Number of licenses purchased.
startDate	object	Required. The start date. (id: GoogleTypeDate)
state	string	Output only. The state of the license config.
subscriptionTerm	string	Required. Subscription term.
subscriptionTier	string	Required. Subscription tier information for the license config.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_license_configs_get	select	projectsId, locationsId, licenseConfigsId		Gets a LicenseConfig.
projects_locations_license_configs_create	insert	projectsId, locationsId	licenseConfigId	Creates a LicenseConfig
projects_locations_license_configs_patch	update	projectsId, locationsId, licenseConfigsId	updateMask	Updates the LicenseConfig

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
licenseConfigsId	string
locationsId	string
projectsId	string
licenseConfigId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_license_configs_get

Gets a LicenseConfig.

SELECT
name,
autoRenew,
endDate,
freeTrial,
geminiBundle,
licenseCount,
startDate,
state,
subscriptionTerm,
subscriptionTier
FROM google.discoveryengine.license_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND licenseConfigsId = '{{ licenseConfigsId }}' -- required
;

INSERT examples

projects_locations_license_configs_create

Creates a LicenseConfig

INSERT INTO google.discoveryengine.license_configs (
data__endDate,
data__licenseCount,
data__name,
data__startDate,
data__subscriptionTier,
data__subscriptionTerm,
data__freeTrial,
data__autoRenew,
projectsId,
locationsId,
licenseConfigId
)
SELECT 
'{{ endDate }}',
'{{ licenseCount }}',
'{{ name }}',
'{{ startDate }}',
'{{ subscriptionTier }}',
'{{ subscriptionTerm }}',
{{ freeTrial }},
{{ autoRenew }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ licenseConfigId }}'
RETURNING
name,
autoRenew,
endDate,
freeTrial,
geminiBundle,
licenseCount,
startDate,
state,
subscriptionTerm,
subscriptionTier
;

Manifest

# Description fields are for documentation purposes
- name: license_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the license_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the license_configs resource.
    - name: endDate
      value: object
      description: >
        Optional. The planed end date.
        
    - name: licenseCount
      value: string
      description: >
        Required. Number of licenses purchased.
        
    - name: name
      value: string
      description: >
        Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
        
    - name: startDate
      value: object
      description: >
        Required. The start date.
        
    - name: subscriptionTier
      value: string
      description: >
        Required. Subscription tier information for the license config.
        
      valid_values: ['SUBSCRIPTION_TIER_UNSPECIFIED', 'SUBSCRIPTION_TIER_SEARCH', 'SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT', 'SUBSCRIPTION_TIER_NOTEBOOK_LM', 'SUBSCRIPTION_TIER_FRONTLINE_WORKER', 'SUBSCRIPTION_TIER_AGENTSPACE_STARTER', 'SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS', 'SUBSCRIPTION_TIER_ENTERPRISE', 'SUBSCRIPTION_TIER_EDU', 'SUBSCRIPTION_TIER_EDU_PRO', 'SUBSCRIPTION_TIER_EDU_EMERGING', 'SUBSCRIPTION_TIER_EDU_PRO_EMERGING', 'SUBSCRIPTION_TIER_FRONTLINE_STARTER']
    - name: subscriptionTerm
      value: string
      description: >
        Required. Subscription term.
        
      valid_values: ['SUBSCRIPTION_TERM_UNSPECIFIED', 'SUBSCRIPTION_TERM_ONE_MONTH', 'SUBSCRIPTION_TERM_ONE_YEAR', 'SUBSCRIPTION_TERM_THREE_YEARS']
    - name: freeTrial
      value: boolean
      description: >
        Optional. Whether the license config is for free trial.
        
    - name: autoRenew
      value: boolean
      description: >
        Optional. Whether the license config should be auto renewed when it reaches the end date.
        
    - name: licenseConfigId
      value: string

UPDATE examples

projects_locations_license_configs_patch

Updates the LicenseConfig

UPDATE google.discoveryengine.license_configs
SET 
data__endDate = '{{ endDate }}',
data__licenseCount = '{{ licenseCount }}',
data__name = '{{ name }}',
data__startDate = '{{ startDate }}',
data__subscriptionTier = '{{ subscriptionTier }}',
data__subscriptionTerm = '{{ subscriptionTerm }}',
data__freeTrial = {{ freeTrial }},
data__autoRenew = {{ autoRenew }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND licenseConfigsId = '{{ licenseConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
autoRenew,
endDate,
freeTrial,
geminiBundle,
licenseCount,
startDate,
state,
subscriptionTerm,
subscriptionTier;