Linee guida per denominare una risorsa Knowledge Catalog

Una risorsa Google Cloud è qualsiasi componente che crei o utilizzi all'interno di Google Cloud. Queste risorse costituiscono i componenti di base delle tue applicazioni e dei tuoi sistemi in esecuzione sulla piattaforma.

Per saperne di più sulla denominazione generale delle risorse Google Cloud , consulta Nomi delle risorse.

Formato di denominazione delle risorse

La tabella seguente elenca i formati dei nomi completi delle risorse di Knowledge Catalog:

Risorsa Formato del nome completo della risorsa
Gruppo di voci projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Entry projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
Tipo di voce projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}
Tipo di aspetto projects/{PROJECT_ID}/locations/{LOCATION}/aspectTypes/{ASPECT_TYPE_ID}
Link di accesso projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
Job metadati projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
Feed dei metadati projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
Glossario projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
Categoria del glossario projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
Termine del glossario projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
Prodotto di dati projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
Dominio di dati projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
Processo di derivazione projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Esecuzione della derivazione projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
Evento di derivazione projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Componenti del nome della risorsa

Le sezioni seguenti forniscono un'analisi dettagliata di ciascun componente.

ID progetto

Il valore deve essere l'ID progetto o il numero del progetto, disponibile nella console Google Cloud . Ad esempio, my-cool-project è un ID progetto, mentre 123456789123 è un numero di progetto.

Località

Il valore deve essere una delle località supportate di Knowledge Catalog. Per un elenco delle località disponibili, consulta Località di Knowledge Catalog.

ID risorsa

I percorsi delle risorse contengono segmenti di identificatori univoci (ID) per ogni risorsa e le relative risorse principali nella gerarchia. Le sezioni seguenti spiegano le linee guida per la denominazione e i requisiti di formattazione per ogni tipo di ID risorsa.

ID risorsa standard

Ad eccezione degli ID voce e degli ID risorsa di derivazione dei dati, tutte le variabili degli ID risorsa, come {ENTRY_GROUP_ID} e {GLOSSARY_ID}, devono essere conformi alle seguenti linee guida:

  • Deve iniziare con una lettera minuscola.
  • Contenere un numero di caratteri compreso tra 1 e 63.
  • Contenere solo lettere minuscole, numeri, trattini e trattini bassi.
  • Terminare con un numero o una lettera minuscola.

Gruppi di voci di sistema

ID voce

Le linee guida per la denominazione di un {ENTRY_ID} sono diverse:

  • Contenere fino a 4000 caratteri.

  • Utilizza un formato ID voce basato sul nome completo della risorsa Google Cloud. Il formato è il nome completo della risorsa senza i doppi slash del prefisso nella parte del nome del servizio API. In questo modo è possibile recuperare le voci utilizzando il nome della risorsa associata.

    Ad esempio:

    • Se il nome completo della risorsa di un'istanza di Looker è //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, il valore {ENTRY_ID} suggerito è looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

ID risorsa di derivazione dei dati

Le risorse di derivazione dei dati rappresentano una gerarchia di operazioni di trasformazione dei dati:

  • ID di processo ({PROCESS_ID}): identifica la definizione di una trasformazione dei dati (ad esempio una query SQL specifica o una pipeline ETL).
  • ID esecuzione ({RUN_ID}): identifica una singola istanza di esecuzione di un processo principale.
  • ID evento di derivazione ({LINEAGE_EVENT_ID}): identifica un evento di movimento dei dati discreto tra origini e destinazioni che si è verificato durante un'esecuzione.

Quando crei risorse di derivazione personalizzate tramite l'API, le variabili {PROCESS_ID}, {RUN_ID} e {LINEAGE_EVENT_ID} devono essere conformi alle seguenti linee guida:

  • Contenere fino a 200 caratteri.
  • Contenere solo lettere (sensibili alle maiuscole), numeri, trattini, trattini bassi, due punti e punti.

Per la derivazione automatizzata (ad esempio query BigQuery, Managed Service for Apache Spark o importazione OpenLineage), Knowledge Catalog genera automaticamente questi ID.

Nomi delle voci di BigQuery

Quando interagisci con le risorse BigQuery tramite l'API Dataplex, devi utilizzare una formattazione specifica per l'ID gruppo di voci e l'ID voce.

  • ID gruppo di voci: @bigquery
  • ID voce: bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Esempio

Se la tabella BigQuery è projects/test-project/datasets/test_dataset/tables/test_table, il nome completo della voce di Knowledge Catalog è il seguente:

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