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.

Weitere Informationen zur allgemeinen Google Cloud Ressourcennamen, finden Sie unter Ressourcennamen.

Format für Ressourcennamen

In der folgenden Tabelle sind die Formate für vollständige Ressourcennamen für Knowledge Catalog-Ressourcen aufgeführt:

Ressource Format für vollständige Ressourcennamen
Eintragsgruppe projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Eintrag projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
Eintragstyp projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}
Aspekttyp projects/{PROJECT_ID}/locations/{LOCATION}/aspectTypes/{ASPECT_TYPE_ID}
Eintragslink projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
Metadatenjob projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
Metadatenfeed projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
Glossar projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
Glossarkategorie projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
Glossarbegriff projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
Datenprodukt projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
Datendomain projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
Herkunftsprozess projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Herkunftsausführung projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
Herkunftsereignis projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Komponenten von Ressourcennamen

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. Beispielsweise ist my-cool-project 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.

Ressourcen-ID

Ressourcenpfade enthalten eindeutige Kennungen (ID) für jede Ressource und ihre übergeordneten Ressourcen in der Hierarchie. In den folgenden Abschnitten werden die Namensrichtlinien und Formatierungsanforderungen für die einzelnen Ressourcentypen erläutert.

Standardressourcen-IDs

Mit Ausnahme von Eintrags-IDs und Ressourcen-IDs für die Datenherkunft müssen alle Variablen für Ressourcen-IDs, wie {ENTRY_GROUP_ID} und {GLOSSARY_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

Systemeintragsgruppen

Eintrags-IDs

Für eine {ENTRY_ID} gelten andere Namensrichtlinien:

  • Darf bis zu 4.000 Zeichen enthalten

  • Muss ein Eintrags-ID-Format verwenden, 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 //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, dann lautet die vorgeschlagene {ENTRY_ID} looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

Ressourcen-IDs für die Datenherkunft

Ressourcen für die Datenherkunft stellen eine Hierarchie von Datenumwandlungsvorgängen dar:

  • Prozess-ID ({PROCESS_ID}): Gibt die Definition einer Datenumwandlung an, z. B. eine bestimmte SQL-Abfrage oder ETL-Pipeline.
  • Ausführungs-ID ({RUN_ID}): Gibt eine einzelne Ausführungsinstanz von einem übergeordneten Prozess an.
  • Herkunftsereignis-ID ({LINEAGE_EVENT_ID}): Gibt ein einzelnes Datenübertragungsereignis zwischen Quellen und Zielen an, das während einer Ausführung aufgetreten ist.

Wenn Sie benutzerdefinierte Ressourcen für die Herkunft über die API erstellen, 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

Bei der automatisierten Herkunft (z. B. BigQuery-Abfragen, Managed Service for Apache Spark oder OpenLineage-Aufnahme) generiert Knowledge Catalog diese IDs automatisch.

BigQuery-Eintragsnamen

Wenn Sie über die Knowledge Catalog APIs mit BigQuery-Ressourcen interagieren, müssen Sie für die Eintragsgruppen-ID und die Eintrags-ID ein bestimmtes Format 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}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table