Consignes pour nommer une ressource Knowledge Catalog

Une Google Cloud ressource est tout composant que vous créez ou utilisez dans Google Cloud. Ces ressources constituent les blocs de construction de vos applications et systèmes exécutés sur la plate-forme.

Pour en savoir plus sur l'attribution de noms aux ressources en général Google Cloud , consultez Noms de ressources.

Format des noms de ressources

Le tableau suivant répertorie les formats de noms de ressources complets pour les ressources Knowledge Catalog :

Ressource Format du nom de ressource complet
Groupe d'entrées projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Entrée projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
Type d'entrée projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}
Type d'aspect projects/{PROJECT_ID}/locations/{LOCATION}/aspectTypes/{ASPECT_TYPE_ID}
Lien d'entrée projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
Job de métadonnées projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
Flux de métadonnées projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
Glossaire projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
Catégorie de glossaire projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
Terme de glossaire projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
Produit de données projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
Domaine de données projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
Processus de traçabilité projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Exécution de la traçabilité projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
Événement de traçabilité projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Composants des noms de ressources

Les sections suivantes décrivent chaque composant.

ID du projet

La valeur doit correspondre à l'ID du projet ou au numéro du projet, disponible dans la Google Cloud console. Par exemple, my-cool-project est un ID de projet, tandis que 123456789123 est un numéro de projet.

Emplacement

La valeur doit correspondre à l'un des emplacements Knowledge Catalog compatibles. Pour obtenir la liste des emplacements disponibles, consultez Emplacements Knowledge Catalog.

ID de ressource

Les chemins d'accès aux ressources contiennent des segments d'identifiant unique (ID) pour chaque ressource et ses ressources parentes dans la hiérarchie. Les sections suivantes décrivent les consignes de nommage et les exigences de format pour chaque type d'ID de ressource.

ID de ressource standards

À l'exception des ID d'entrée et des ID de ressource de traçabilité des données, toutes les variables d'ID de ressource, telles que {ENTRY_GROUP_ID} et {GLOSSARY_ID}, doivent respecter les consignes suivantes :

  • Commencer par une lettre minuscule.
  • Contenir entre 1 et 63 caractères.
  • Ne contenir que des lettres minuscules, des chiffres, des traits d'union et des traits de soulignement.
  • Se terminer par un chiffre ou une lettre minuscule.

Groupes d'entrées système

ID d'entrée

Les consignes de nommage d'un {ENTRY_ID} sont différentes :

  • Contenir jusqu'à 4 000 caractères.

  • Utiliser un format d'ID d'entrée basé sur le Google Cloud nom de ressource complet. Le format correspond au nom de ressource complet de la ressource sans les doubles barres obliques de préfixe dans la partie du nom du service API. Cela permet de récupérer des entrées à l'aide de leur nom de ressource associé.

    Exemple :

    • Si le nom de ressource complet d'une instance Looker est //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, le {ENTRY_ID} suggéré est looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

ID de ressource de traçabilité des données

Les ressources de traçabilité des données représentent une hiérarchie d'opérations de transformation des données :

  • ID de processus ({PROCESS_ID}) : identifie la définition d'une transformation de données (par exemple, une requête SQL spécifique ou un pipeline ETL).
  • ID d'exécution ({RUN_ID}) : identifie une seule instance d'exécution d' un processus parent.
  • ID d'événement de traçabilité ({LINEAGE_EVENT_ID}) : identifie un événement de déplacement de données discret entre les sources et les cibles qui s'est produit lors d'une exécution.

Lorsque vous créez des ressources de traçabilité personnalisées via l'API, les variables {PROCESS_ID}, {RUN_ID}, et {LINEAGE_EVENT_ID} doivent respecter les consignes suivantes :

  • Contenir jusqu'à 200 caractères.
  • Ne contenir que des lettres (sensibles à la casse), des chiffres, des traits d'union, des traits de soulignement, des deux-points et des points.

Pour la traçabilité automatisée (par exemple, les requêtes BigQuery, Managed Service pour Apache Spark ou l'ingestion OpenLineage), Knowledge Catalog génère automatiquement ces ID.

Noms d'entrée BigQuery

Lorsque vous interagissez avec des ressources BigQuery via les API Knowledge Catalog, vous devez utiliser un format spécifique pour l'ID de groupe d'entrées et l'ID d'entrée.

  • ID de groupe d'entrées : @bigquery
  • ID d'entrée : bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Exemple

Si votre table BigQuery est projects/test-project/datasets/test_dataset/tables/test_table, le nom d'entrée Knowledge Catalog complet est le suivant :

projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table