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.

Les ressources du Knowledge Catalog incluent les éléments suivants :

  • Groupe d'entrées

  • Entrée

  • Type d'entrée

  • Type d'aspect

  • Lien d'entrée

  • Job de métadonnées

  • Flux de métadonnées

  • Glossaire

  • Catégorie du glossaire

  • Terme du glossaire

  • Produit de données

  • Domaine de données

  • Processus de traçabilité

  • Exécution de la traçabilité

  • Événement de traçabilité

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

Format d'attribution de noms aux ressources

Voici les formats des différentes ressources :

  • Groupe d'entrées : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}

  • Entrée : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}

  • Type d'entrée : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryTypes/{ENTRY_TYPE_ID}

  • Type d'aspect : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/aspectTypes/{ASPECT_TYPE_ID}

  • Lien d'entrée : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}

  • Job de métadonnées : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataJobs/{METADATA_JOB_ID}

  • Flux de métadonnées : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataFeeds/{METADATA_FEED_ID}

  • Glossaire : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}

  • Catégorie du glossaire : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}

  • Terme du glossaire : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}

  • Produit de données : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataProducts/{DATA_PRODUCT_ID}

  • Domaine de données : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataDomains/{DATA_DOMAIN_ID}

  • Processus : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}

  • Exécution : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}

  • Événement de traçabilité : projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Les sections suivantes fournissent une description détaillée de 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

ID est le dernier segment du chemin d'accès à la ressource.

Pour la plupart des ressources (groupes d'entrées, types d'entrées, types d'aspects, liens d'entrées, jobs de métadonnées, flux de métadonnées, glossaires, catégories de glossaires, termes de glossaires, produits de données et domaines de données), les variables telles que {ENTRY_GROUP_ID}, {ENTRY_TYPE_ID}, {ASPECT_TYPE_ID}, {ENTRY_LINK_ID}, {METADATA_JOB_ID}, {METADATA_FEED_ID}, {GLOSSARY_ID}, {GLOSSARY_CATEGORY_ID}, {GLOSSARY_TERM_ID}, {DATA_PRODUCT_ID} et {DATA_DOMAIN_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

Les consignes d'attribution de noms pour 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 complet de la ressource. Le format correspond au nom 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 complet de la ressource 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.

Pour les ressources de traçabilité des données, telles que les processus, les exécutions et les événements de traçabilité, 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

Noms d'entrées 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_NAME}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table