Richtlinien zum Benennen einer Knowledge Catalog-Ressource

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

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

Format für Ressourcennamen

In der folgenden Tabelle sind die vollständigen Ressourcennamenformate für Knowledge Catalog-Ressourcen aufgeführt:

Ressource Format von vollständigen 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}
Lineage-Prozess projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Herkunftslauf 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 des Ressourcennamens

In den folgenden Abschnitten werden die einzelnen Komponenten aufgeschlüsselt.

Projekt-ID

Der Wert muss die Projekt-ID oder Projektnummer sein, die in der Google Cloud Console verfügbar ist. my-cool-project ist beispielsweise 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 Kennungssegmente (ID) für jede Ressource und ihre übergeordneten Ressourcen in der Hierarchie. In den folgenden Abschnitten werden die Benennungsrichtlinien und Formatierungsanforderungen für die einzelnen Ressourcen-ID-Typen erläutert.

Standard-Ressourcen-IDs

Mit Ausnahme von Eintrags-IDs und Ressourcen-IDs für die Datenherkunft müssen alle Ressourcen-ID-Variablen wie {ENTRY_GROUP_ID} und {GLOSSARY_ID} den folgenden Richtlinien entsprechen:

  • Muss mit einem Kleinbuchstaben beginnen
  • Zwischen 1 und 63 Zeichen enthalten.
  • Darf nur Kleinbuchstaben, Ziffern, Bindestriche und Unterstriche enthalten.
  • Muss mit einer Ziffer oder einem Kleinbuchstaben enden.

Systemeintragsgruppen

Eintrags-IDs

Für {ENTRY_ID} gelten andere Richtlinien für die Namensgebung:

  • dürfen bis zu 4.000 Zeichen enthalten.

  • Verwenden Sie ein Eintrags-ID-Format, das auf dem vollständigen Ressourcennamen von Google Cloudbasiert. Das Format ist der vollständige Ressourcenname der Ressource ohne die doppelten Schrägstriche im API-Dienstnamen. 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 lautet, ist der vorgeschlagene {ENTRY_ID} looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

Ressourcen-IDs für die Datenherkunft

Datenherkunftsressourcen stellen eine Hierarchie von Datentransformationsvorgängen dar:

  • Prozess-ID ({PROCESS_ID}): Identifiziert die Definition einer Datentransformation (z. B. eine bestimmte SQL-Abfrage oder ETL-Pipeline).
  • Ausführungs-ID ({RUN_ID}): Identifiziert eine einzelne Ausführungsinstanz eines übergeordneten Prozesses.
  • Herkunftsereignis-ID ({LINEAGE_EVENT_ID}): Identifiziert ein diskretes Datenbewegungsereignis zwischen Quellen und Zielen, das während einer Ausführung aufgetreten ist.

Wenn Sie benutzerdefinierte Herkunftsressourcen über die API erstellen, müssen die Variablen {PROCESS_ID}, {RUN_ID} und {LINEAGE_EVENT_ID} den folgenden Richtlinien entsprechen:

  • dürfen bis zu 200 Zeichen enthalten.
  • Darf nur Buchstaben (Groß-/Kleinschreibung beachten), Ziffern, Bindestriche, Unterstriche, Doppelpunkte und Punkte enthalten.

Für die automatisierte 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 Dataplex API mit BigQuery-Ressourcen interagieren, müssen Sie für die ID der Eintraggruppe 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 vollständig 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