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.
earlyTerminated	boolean	Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
earlyTerminationDate	object	Output only. The date when the subscription is terminated earlier than the expiration date. (id: GoogleTypeDate)
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.
lastUserUpdateTime	string (google-datetime)	Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike update_time, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
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. (STATE_UNSPECIFIED, ACTIVE, EXPIRED, NOT_STARTED, WITHDRAWN, DEACTIVATING)
subscriptionTerm	string	Required. Subscription term. (SUBSCRIPTION_TERM_UNSPECIFIED, SUBSCRIPTION_TERM_ONE_MONTH, SUBSCRIPTION_TERM_ONE_YEAR, SUBSCRIPTION_TERM_THREE_YEARS, SUBSCRIPTION_TERM_CUSTOM)
subscriptionTier	string	Required. Subscription tier information for the license config. (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_ENTERPRISE_EMERGING, SUBSCRIPTION_TIER_EDU, SUBSCRIPTION_TIER_EDU_PRO, SUBSCRIPTION_TIER_EDU_EMERGING, SUBSCRIPTION_TIER_EDU_PRO_EMERGING, SUBSCRIPTION_TIER_FRONTLINE_STARTER, SUBSCRIPTION_TIER_CONSUMPTION_ONLY, SUBSCRIPTION_TIER_EDU_GOV_EMERGING)

projects_locations_license_configs_list

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.
earlyTerminated	boolean	Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
earlyTerminationDate	object	Output only. The date when the subscription is terminated earlier than the expiration date. (id: GoogleTypeDate)
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.
lastUserUpdateTime	string (google-datetime)	Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike update_time, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
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. (STATE_UNSPECIFIED, ACTIVE, EXPIRED, NOT_STARTED, WITHDRAWN, DEACTIVATING)
subscriptionTerm	string	Required. Subscription term. (SUBSCRIPTION_TERM_UNSPECIFIED, SUBSCRIPTION_TERM_ONE_MONTH, SUBSCRIPTION_TERM_ONE_YEAR, SUBSCRIPTION_TERM_THREE_YEARS, SUBSCRIPTION_TERM_CUSTOM)
subscriptionTier	string	Required. Subscription tier information for the license config. (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_ENTERPRISE_EMERGING, SUBSCRIPTION_TIER_EDU, SUBSCRIPTION_TIER_EDU_PRO, SUBSCRIPTION_TIER_EDU_EMERGING, SUBSCRIPTION_TIER_EDU_PRO_EMERGING, SUBSCRIPTION_TIER_FRONTLINE_STARTER, SUBSCRIPTION_TIER_CONSUMPTION_ONLY, SUBSCRIPTION_TIER_EDU_GOV_EMERGING)

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_list	select	projectsId, locationsId	pageToken, filter, pageSize	Lists all the LicenseConfigs associated with the project.
projects_locations_license_configs_create	insert	projectsId, locationsId	licenseConfigId	Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.
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
filter	string
licenseConfigId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_license_configs_get

Gets a LicenseConfig.

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

projects_locations_license_configs_list

Lists all the LicenseConfigs associated with the project.

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

INSERT examples

projects_locations_license_configs_create

Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.

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

Manifest

# Description fields are for documentation purposes
- name: license_configs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the license_configs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the license_configs resource.
  - name: subscriptionTerm
    value: "{{ subscriptionTerm }}"
    description: |
      Required. Subscription term.
    valid_values: ['SUBSCRIPTION_TERM_UNSPECIFIED', 'SUBSCRIPTION_TERM_ONE_MONTH', 'SUBSCRIPTION_TERM_ONE_YEAR', 'SUBSCRIPTION_TERM_THREE_YEARS', 'SUBSCRIPTION_TERM_CUSTOM']
  - name: autoRenew
    value: {{ autoRenew }}
    description: |
      Optional. Whether the license config should be auto renewed when it reaches the end date.
  - name: freeTrial
    value: {{ freeTrial }}
    description: |
      Optional. Whether the license config is for free trial.
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
  - name: licenseCount
    value: "{{ licenseCount }}"
    description: |
      Required. Number of licenses purchased.
  - name: subscriptionTier
    value: "{{ subscriptionTier }}"
    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_ENTERPRISE_EMERGING', 'SUBSCRIPTION_TIER_EDU', 'SUBSCRIPTION_TIER_EDU_PRO', 'SUBSCRIPTION_TIER_EDU_EMERGING', 'SUBSCRIPTION_TIER_EDU_PRO_EMERGING', 'SUBSCRIPTION_TIER_FRONTLINE_STARTER', 'SUBSCRIPTION_TIER_CONSUMPTION_ONLY', 'SUBSCRIPTION_TIER_EDU_GOV_EMERGING']
  - name: endDate
    description: |
      Optional. The planed end date.
    value:
      year: {{ year }}
      month: {{ month }}
      day: {{ day }}
  - name: startDate
    description: |
      Required. The start date.
    value:
      year: {{ year }}
      month: {{ month }}
      day: {{ day }}
  - name: lastUserUpdateTime
    value: "{{ lastUserUpdateTime }}"
    description: |
      Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
  - name: licenseConfigId
    value: "{{ licenseConfigId }}"

UPDATE examples

projects_locations_license_configs_patch

Updates the LicenseConfig

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