Richtlinien zum Benennen einer Knowledge Catalog-Ressource

Eine Google Cloud Ressource ist eine Komponente, die Sie in Google Clouderstellen oder verwenden. Diese Ressourcen bilden die Bausteine Ihrer Anwendungen und Systeme, die auf der Plattform ausgeführt werden.

Zu den Ressourcen in Knowledge Catalog gehören:

  • Eintragsgruppe

  • Eintrag

  • Eintragstyp

  • Aspekttyp

  • Eintragslink

  • Metadatenjob

  • Metadatenfeed

  • Glossar

  • Glossarkategorie

  • Glossarbegriff

  • Datenprodukt

  • Datendomain

  • Lineage-Prozess

  • Lineage-Ausführung

  • Lineage-Ereignis

Weitere Informationen zur allgemeinen Google Cloud Benennung von Ressourcen finden Sie unter Ressourcennamen.

Format für die Benennung von Ressourcen

Hier sind die Formate für die verschiedenen Ressourcen:

  • Eintragsgruppe: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}

  • Eintrag: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}

  • Eintragstyp: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryTypes/{ENTRY_TYPE_ID}

  • Aspekttyp: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/aspectTypes/{ASPECT_TYPE_ID}

  • Eintragslink: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}

  • Metadatenjob: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataJobs/{METADATA_JOB_ID}

  • Metadatenfeed: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataFeeds/{METADATA_FEED_ID}

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

  • Glossarkategorie: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}

  • Glossarbegriff: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}

  • Datenprodukt: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataProducts/{DATA_PRODUCT_ID}

  • Datendomain: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataDomains/{DATA_DOMAIN_ID}

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

  • Ausführung: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}

  • Lineage-Ereignis: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

In den folgenden Abschnitten wird jede Komponente aufgeschlüsselt.

Projekt-ID

Der Wert muss die Projekt-ID oder Projektnummer sein, die in der Google Cloud Konsole verfügbar ist. Beispiel: my-cool-project ist eine Projekt-ID, während 123456789123 eine Projektnummer ist.

Standort

Der Wert muss einer der unterstützten Knowledge Catalog-Standorte sein. Eine Liste der verfügbaren Standorte finden Sie unter Knowledge Catalog-Standorte.

ID

ID ist das letzte Segment im Ressourcenpfad.

Für die meisten Ressourcen (Eintragsgruppen, Eintragstypen, Aspekttypen, Eintragslinks, Metadatenjobs, Metadatenfeeds, Glossare, Glossarkategorien, Glossarbegriffe, Datenprodukte und Datendomains) müssen Variablen wie {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}, und {DATA_DOMAIN_ID} den folgenden Richtlinien entsprechen:

  • Muss mit einem Kleinbuchstaben beginnen

  • Muss zwischen 1 und 63 Zeichen enthalten

  • Darf nur Kleinbuchstaben, Zahlen, Bindestriche und Unterstriche enthalten

  • Muss mit einer Zahl oder einem Kleinbuchstaben enden

Die Benennungsrichtlinien für eine {ENTRY_ID} sind anders:

  • Darf bis zu 4.000 Zeichen enthalten

  • Verwenden Sie ein Eintrags-ID-Format, das auf dem Google Cloud vollständigen Ressourcennamen basiert. Das Format ist der vollständige Ressourcenname der Ressource ohne die doppelten Schrägstriche im Präfix des API-Dienstnamens. So können Einträge anhand ihres zugehörigen Ressourcennamens abgerufen werden.

    Beispiel:

    • Wenn der vollständige Ressourcenname einer Looker-Instanz ist //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, dann ist die empfohlene {ENTRY_ID} looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

Für Ressourcen zur Daten-Lineage wie Prozesse, Ausführungen und Lineage-Ereignisse müssen die Variablen {PROCESS_ID}, {RUN_ID} und {LINEAGE_EVENT_ID} den folgenden Richtlinien entsprechen:

  • Darf bis zu 200 Zeichen enthalten

  • Darf nur Buchstaben (Groß-/Kleinschreibung beachten), Zahlen, Bindestriche, Unterstriche, Doppelpunkte und Punkte enthalten

BigQuery-Eintragsnamen

Wenn Sie über die Knowledge Catalog APIs mit BigQuery-Ressourcen interagieren, müssen Sie ein bestimmtes Format für die Eintragsgruppen-ID und die Eintrags-ID verwenden.

  • Eintragsgruppen-ID: @bigquery
  • Eintrags-ID: bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Beispiel

Wenn Ihre BigQuery-Tabelle projects/test-project/datasets/test_dataset/tables/test_table ist, lautet der voll qualifizierte Knowledge Catalog-Eintragsname so:

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