effective_config
Creates, updates, deletes, gets or lists an effective_config
resource.
Overview
Name | effective_config |
Type | Resource |
Id | google.datacatalog.effective_config |
Fields
The following fields are returned by SELECT
queries:
- projects_locations_retrieve_effective_config
- organizations_locations_retrieve_effective_config
Successful response
Name | Datatype | Description |
---|---|---|
catalogUiExperience | string | Opt-in status for the UI switch to Dataplex Universal Catalog. |
tagTemplateMigration | string | Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. |
templateMigrationEnabledTime | string (google-datetime) | The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set. |
Successful response
Name | Datatype | Description |
---|---|---|
catalogUiExperience | string | Opt-in status for the UI switch to Dataplex Universal Catalog. |
tagTemplateMigration | string | Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. |
templateMigrationEnabledTime | string (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:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
projects_locations_retrieve_effective_config | select | projectsId , locationsId | 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. | |
organizations_locations_retrieve_effective_config | select | organizationsId , locationsId | 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. |
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 | |
organizationsId | string | |
projectsId | string |
SELECT
examples
- projects_locations_retrieve_effective_config
- organizations_locations_retrieve_effective_config
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;
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 organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;