Panduan untuk memberi nama resource Knowledge Catalog

Resource Google Cloud adalah komponen apa pun yang Anda buat atau gunakan dalam Google Cloud. Resource ini membentuk elemen penyusun aplikasi dan sistem Anda yang berjalan di platform.

Untuk mengetahui informasi selengkapnya tentang penamaan resource Google Cloud umum, lihat Nama resource.

Format penamaan resource

Tabel berikut mencantumkan format nama resource lengkap untuk resource Knowledge Catalog:

Resource Format nama lengkap resource
Grup entri projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Entri projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
Jenis entri projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}
Jenis aspek projects/{PROJECT_ID}/locations/{LOCATION}/aspectTypes/{ASPECT_TYPE_ID}
Link entri projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
Tugas metadata projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
Feed metadata projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
Glosarium projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
Kategori glosarium projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
Istilah glosarium projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
Produk data projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
Domain data projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
Proses silsilah projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Lineage run projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
Peristiwa silsilah projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Komponen nama resource

Bagian berikut memberikan perincian setiap komponen.

Project ID

Nilainya harus berupa project ID atau nomor project, yang tersedia dari konsol Google Cloud . Misalnya, my-cool-project adalah project ID, sedangkan 123456789123 adalah nomor project.

Lokasi

Nilai harus berupa salah satu lokasi Knowledge Catalog yang didukung. Untuk mengetahui daftar lokasi yang tersedia, lihat Lokasi Knowledge Catalog.

ID resource

Jalur resource berisi segmen ID unik (ID) untuk setiap resource dan resource induknya dalam hierarki. Bagian berikut menjelaskan panduan penamaan dan persyaratan pemformatan untuk setiap jenis ID resource.

ID resource standar

Kecuali untuk ID entri dan ID resource silsilah data, semua variabel ID resource, seperti {ENTRY_GROUP_ID} dan {GLOSSARY_ID}, harus sesuai dengan panduan berikut:

  • Dimulai dengan huruf kecil.
  • Berisi antara 1 hingga 63 karakter.
  • Hanya berisi huruf kecil, angka, tanda hubung, dan garis bawah.
  • Diakhiri dengan angka atau huruf kecil.

Grup entri sistem

ID Entri

Panduan penamaan untuk {ENTRY_ID} berbeda:

  • Berisi maksimal 4.000 karakter.

  • Gunakan format ID entri berdasarkan Google Cloud nama resource lengkap. Formatnya adalah nama resource lengkap tanpa garis miring ganda awalan di bagian nama layanan API. Hal ini memungkinkan pengambilan entri menggunakan nama resource terkait.

    Contoh:

    • Jika nama resource lengkap instance Looker adalah //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, {ENTRY_ID} yang disarankan adalah looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

ID resource silsilah data

Resource silsilah data merepresentasikan hierarki operasi transformasi data:

  • ID Proses ({PROCESS_ID}): Mengidentifikasi definisi transformasi data (seperti kueri SQL atau pipeline ETL tertentu).
  • ID Operasi ({RUN_ID}): Mengidentifikasi satu instance eksekusi dari proses induk.
  • ID peristiwa silsilah ({LINEAGE_EVENT_ID}): Mengidentifikasi peristiwa pergerakan data diskret antara sumber dan target yang terjadi selama operasi.

Saat Anda membuat resource silsilah kustom melalui API, variabel {PROCESS_ID}, {RUN_ID}, dan {LINEAGE_EVENT_ID} harus sesuai dengan panduan berikut:

  • Berisi maksimal 200 karakter.
  • Hanya berisi huruf (peka huruf besar/kecil), angka, tanda hubung, garis bawah, titik dua, dan titik.

Untuk silsilah otomatis (seperti kueri BigQuery, Managed Service untuk Apache Spark, atau penyerapan OpenLineage), Knowledge Catalog akan otomatis membuat ID ini.

Nama entri BigQuery

Saat berinteraksi dengan resource BigQuery melalui Dataplex API, Anda harus menggunakan format khusus untuk ID grup entri dan ID entri.

  • ID grup entri: @bigquery
  • ID Entri: bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Contoh

Jika tabel BigQuery Anda adalah projects/test-project/datasets/test_dataset/tables/test_table, nama entri Knowledge Catalog yang sepenuhnya memenuhi syarat adalah sebagai berikut:

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