Skip to main content

effective_config

Creates, updates, deletes, gets or lists an effective_config resource.

Overview

Nameeffective_config
TypeResource
Idgoogle.datacatalog.effective_config

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
catalogUiExperiencestringOpt-in status for the UI switch to Dataplex Universal Catalog.
tagTemplateMigrationstringOpt-in status for the migration of Tag Templates to Dataplex Universal Catalog.
templateMigrationEnabledTimestring (google-datetime)The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_retrieve_effective_configselectprojectsId, locationsIdRetrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
organizations_locations_retrieve_effective_configselectorganizationsId, locationsIdRetrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

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.

NameDatatypeDescription
locationsIdstring
organizationsIdstring
projectsIdstring

SELECT examples

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

SELECT
catalogUiExperience,
tagTemplateMigration,
templateMigrationEnabledTime
FROM google.datacatalog.effective_config
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;