Linee guida per denominare una risorsa Knowledge Catalog

Una Google Cloud risorsa è qualsiasi componente che crei o utilizzi in Google Cloud. Queste risorse costituiscono i blocchi predefiniti delle applicazioni e dei sistemi in esecuzione sulla piattaforma.

Per ulteriori informazioni sulla denominazione delle risorse generali Google Cloud , consulta Nomi delle risorse.

Formato di denominazione delle risorse

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

Risorsa Formato del nome completo della risorsa
Gruppo di voci projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Voce 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 della voce projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
Job dei metadati projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
Feed di 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 tracciabilità projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Esecuzione della derivazione projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
Evento di tracciabilità projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Componenti del nome della risorsa

Le sezioni seguenti forniscono una suddivisione di ogni componente.

ID progetto

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

Località

Il valore deve essere una delle località di Knowledge Catalog supportate. 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 tracciabilità dei dati, tutte le variabili ID risorsa, come {ENTRY_GROUP_ID} e {GLOSSARY_ID}, devono rispettare le seguenti linee guida:

  • Deve iniziare con una lettera minuscola.
  • Deve contenere da 1 a 63 caratteri.
  • Deve contenere solo lettere minuscole, numeri, trattini e trattini bassi.
  • Deve 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:

  • Deve contenere fino a 4000 caratteri.

  • Utilizza un formato ID voce basato sul Google Cloud nome completo della risorsa. Il formato è il nome completo della risorsa senza le barre doppie 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, allora il suggerito {ENTRY_ID} è 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 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 tracciabilità ({LINEAGE_EVENT_ID}): identifica un evento di spostamento dei dati discreto tra origini e target avvenuto durante un'esecuzione.

Quando crei risorse di tracciabilità personalizzate tramite l'API, le variabili {PROCESS_ID}, {RUN_ID} e {LINEAGE_EVENT_ID} devono rispettare le seguenti linee guida:

  • Deve contenere fino a 200 caratteri.
  • Deve contenere solo lettere (distingue tra maiuscole e minuscole), numeri, trattini, trattini bassi, due punti e punti.

Per la tracciabilità automatica (ad esempio query BigQuery, Managed Service for Apache Spark o inserimento OpenLineage), Knowledge Catalog genera automaticamente questi ID.

Nomi delle voci di BigQuery

Quando interagisci con le risorse BigQuery tramite le API Knowledge Catalog, devi utilizzare una formattazione specifica per l'ID del 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 della voce di Knowledge Catalog completo è il seguente:

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