- Resource: IcebergCatalog
- CredentialMode
- CatalogType
- Replika
- Status
- RestrictedLocationsConfig
- EncryptionConfig
- FederatedCatalogOptions
- IdentityFederationOrganizationServiceAccount
- UnityCatalogInfo
- GlueCatalogInfo
- SnowflakeCatalogInfo
- WorkdayCatalogInfo
- IdentityMode
- UserIdentityFederationOidcClaims
- UserIdentityFederationOidc
- RefreshOptions
- RefreshSchedule
- RefreshScope
- RefreshStatus
- CrossCloudCacheOptions
- Metode
Resource: IcebergCatalog
Informasi Katalog REST Iceberg.
| Representasi JSON |
|---|
{ "name": string, "credential-mode": enum ( |
| Kolom | |
|---|---|
name |
ID. Nama katalog, |
credential-mode |
Opsional. Mode kredensial untuk katalog. |
biglake-service-account |
Hanya output. Akun layanan yang digunakan untuk penyediaan kredensial, hanya output. Mungkin kosong jika penjualan kredensial tidak pernah diaktifkan untuk katalog. Untuk katalog gabungan, akun layanan akan selalu disediakan dan digunakan untuk mengakses katalog jarak jauh untuk pembaruan metadata latar belakang. Jika |
biglake-service-account-id |
Hanya output. ID unik akun layanan. Ini digunakan untuk skenario penggabungan. |
catalog-type |
Wajib. Jenis katalog. Wajib diisi untuk catalogs.create. Jenis katalog tidak dapat diubah, kecuali untuk kasus konversi dari CATALOG_TYPE_GCS_BUCKET ke CATALOG_TYPE_BIGLAKE. |
default-location |
Opsional. Lokasi penyimpanan default untuk katalog, misalnya, Untuk katalog BigLake, kolom ini harus disediakan dan mengarah ke bucket Google Cloud Storage atau jalur dalam bucket tersebut. Jalur ini berfungsi sebagai direktori dasar untuk membuat jalur lengkap ke direktori data dan metadata tabel saat lokasi tidak ditentukan di tingkat namespace atau tabel. Jalur lengkap dibentuk dengan menambahkan ID namespace dan tabel ke lokasi default. |
storage-regions[] |
Hanya output. Region Google Cloud dari bucket lokasi default, misalnya |
create-time |
Hanya output. Waktu pembuatan katalog. Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
update-time |
Hanya output. Kapan katalog terakhir diperbarui. Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
replicas[] |
Hanya output. Replika untuk metadata katalog. |
description |
Opsional. Deskripsi katalog yang disediakan pengguna. Deskripsi harus berupa string UTF-8 dengan panjang maksimum 1.024 karakter. |
restricted-locations-config |
Opsional. Konfigurasi lokasi yang dibatasi. Kolom ini saat ini hanya digunakan untuk katalog BigLake. Jika kolom ini tidak disetel, atau jika |
federated-catalog-options |
Opsional. Opsi konfigurasi untuk katalog gabungan. |
cross-cloud-cache-options |
Opsional. Opsi konfigurasi untuk penyimpanan dalam cache lintas cloud untuk file data dan metadata. |
encryption-config |
Opsional. Konfigurasi enkripsi kustom (misalnya, kunci Cloud KMS). |
CredentialMode
Mode kredensial yang digunakan untuk katalog.
| Enum | |
|---|---|
CREDENTIAL_MODE_UNSPECIFIED |
Nilai default/tidak ditetapkan. Nilai ini tidak digunakan. |
CREDENTIAL_MODE_END_USER |
Mode kredensial pengguna akhir, default. Pengguna yang melakukan autentikasi harus memiliki akses ke resource katalog dan objek Google Cloud Storage yang mendasarinya. |
CREDENTIAL_MODE_VENDED_CREDENTIALS |
Mode penyediaan kredensial. Pengguna yang melakukan autentikasi hanya memerlukan akses ke resource katalog dan sistem akan memberikan kredensial dengan cakupan yang dipersempit kepada pemanggil untuk mengakses objek Google Cloud Storage. Semua operasi tabel dalam mode ini mengharuskan header Lihat https://docs.cloud.google.com/lakehouse/docs/credential-vending untuk mengetahui detail selengkapnya. |
CatalogType
Menentukan jenis katalog.
| Enum | |
|---|---|
CATALOG_TYPE_UNSPECIFIED |
Nilai default/tidak ditetapkan. Nilai ini tidak digunakan. |
CATALOG_TYPE_GCS_BUCKET |
Jenis katalog bucket Google Cloud Storage. |
CATALOG_TYPE_BIGLAKE |
Jenis katalog BigLake. |
CATALOG_TYPE_FEDERATED |
Jenis katalog gabungan. |
CATALOG_TYPE_ALLOYDB_AGENT_MODE |
Katalog untuk mengkueri tabel AlloyDB dalam mode agen. |
Replika
Replika Katalog.
| Representasi JSON |
|---|
{
"region": string,
"state": enum ( |
| Kolom | |
|---|---|
region |
Hanya output. Region replika. Misalnya, "us-east1" |
state |
Hanya output. Status replika saat ini. |
Negara bagian/Provinsi
Jika katalog direplikasi ke beberapa region, enum ini menjelaskan status replika saat ini.
| Enum | |
|---|---|
STATE_UNKNOWN |
Nilai default/tidak ditetapkan. Nilai ini tidak digunakan. |
STATE_PRIMARY |
Replika adalah replika utama yang dapat ditulis. |
STATE_PRIMARY_IN_PROGRESS |
Replika baru-baru ini ditetapkan sebagai replika utama, tetapi belum semua namespace dapat ditulis. |
STATE_SECONDARY |
Replika ini adalah replika sekunder hanya baca. |
RestrictedLocationsConfig
Konfigurasi pembatasan lokasi.
| Representasi JSON |
|---|
{ "restricted-locations": [ string ] } |
| Kolom | |
|---|---|
restricted-locations[] |
Opsional. Bucket dan lokasi Google Cloud Storage tambahan (misalnya, Jika |
EncryptionConfig
Konfigurasi enkripsi kustom (misalnya, kunci Cloud KMS).
| Representasi JSON |
|---|
{ "kms-key-name": string } |
| Kolom | |
|---|---|
kms-key-name |
Opsional. Nama kunci Cloud KMS yang digunakan untuk mengenkripsi data yang di-cache yang diambil dari katalog. Format: |
FederatedCatalogOptions
Opsi konfigurasi untuk katalog gabungan.
| Representasi JSON |
|---|
{ "identity-mode": enum ( |
| Kolom | |
|---|---|
identity-mode |
Opsional. Mode identitas untuk katalog gabungan. |
refresh-options |
Opsional. Memuat ulang konfigurasi. |
refresh-status |
Hanya output. Status operasi pembaruan metadata latar belakang. |
| Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
identity-federation-organization-service-account |
Hanya output. Akun layanan tingkat organisasi yang digunakan untuk workforce identity federation. |
| Akhir kolom yang saling eksklusif. | |
| Informasi khusus untuk katalog REST Iceberg jarak jauh. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
unity-catalog-info |
Opsional. Informasi khusus untuk Databricks Unity Catalog. |
glue-catalog-info |
Opsional. Informasi khusus untuk AWS Glue Data Catalog. |
snowflake-catalog-info |
Opsional. Informasi khusus untuk Snowflake Horizon Catalog. |
workday-catalog-info |
Opsional. Informasi khusus untuk Workday Data Lake. |
| Akhir kolom yang saling eksklusif. | |
secret-name |
Opsional. Nama resource secret di Secret Manager, dalam format Project ID harus cocok dengan project katalog dan lokasi harus cocok dengan lokasi katalog. Jika versi tidak ditentukan, versi terbaru akan digunakan. Kolom ini tidak digunakan jika |
service-directory-name |
Opsional. Nama resource Direktori Layanan yang digunakan untuk merutekan traffic lapisan transpor dengan katalog jarak jauh (misalnya, akses file data di bucket penyimpanan) melalui koneksi jaringan pribadi. Format: Hal ini digunakan oleh kueri BigQuery untuk me-resolve endpoint pribadi guna mengambil file data (misalnya, data Iceberg di S3 atau Azure Data Lake Storage) melalui koneksi jaringan pribadi seperti Cross-Cloud Interconnect. |
metadata-service-directory-name |
Opsional. Nama resource Direktori Layanan yang digunakan untuk merutekan traffic lapisan metadata dengan katalog jarak jauh melalui koneksi jaringan pribadi. Format: Digunakan untuk mengambil metadata katalog (seperti konfigurasi, namespace, dan tabel Iceberg) melalui koneksi jaringan pribadi, seperti Cross-Cloud Interconnect. Juga digunakan untuk mengambil token OAuth saat |
user-identity-federation-oidc-claims |
Hanya output. Tidak digunakan lagi: Gunakan Klaim OIDC yang dikeluarkan dalam token ID untuk Federasi Identitas Pengguna. |
user-identity-federation-oidc |
Hanya output. Konfigurasi OIDC untuk User Identity Federation. |
IdentityFederationOrganizationServiceAccount
Akun layanan tingkat organisasi yang digunakan untuk penggabungan identitas, hanya output. Mungkin kosong jika penggabungan identitas tidak pernah diaktifkan untuk katalog.
| Representasi JSON |
|---|
{ "service-account": string, "service-account-unique-id": string } |
| Kolom | |
|---|---|
service-account |
Hanya output. Email akun layanan level organisasi. |
service-account-unique-id |
Hanya output. ID unik akun layanan tingkat organisasi. |
UnityCatalogInfo
Informasi khusus untuk Databricks Unity Catalog. Endpoint Katalog REST Iceberg memiliki format: https://<instanceName>/api/2.1/unity-catalog/iceberg-rest/v1/config?warehouse=<catalogName>.
| Representasi JSON |
|---|
{ "instance-name": string, "catalog-name": string, "service-principal-application-id": string } |
| Kolom | |
|---|---|
instance-name |
Wajib. Tidak dapat diubah. Nama instance ruang kerja Databricks. Misalnya, untuk URL ruang kerja Databricks |
catalog-name |
Wajib. Tidak dapat diubah. Nama katalog di Databricks Unity Catalog. |
service-principal-application-id |
Opsional. ID aplikasi akun utama layanan Databricks yang digunakan untuk mengakses Databricks Unity Catalog dalam alur autentikasi OIDC. |
GlueCatalogInfo
Informasi khusus untuk AWS Glue Data Catalog. Endpoint Katalog REST Iceberg memiliki format: https://glue.<awsRegion>.amazonaws.com/iceberg/v1/config?warehouse=<warehouse>.
| Representasi JSON |
|---|
{ "warehouse": string, "aws-region": string, "aws-role-arn": string } |
| Kolom | |
|---|---|
warehouse |
Wajib. Tidak dapat diubah. Lokasi warehouse di AWS Glue Data Catalog. Untuk katalog akun default, gunakan ID akun AWS 12 digit (misalnya, |
aws-region |
Wajib. Tidak dapat diubah. Region AWS dari AWS Glue Data Catalog (misalnya, |
aws-role-arn |
Wajib. Amazon Resource Name (ARN) dari peran AWS IAM yang diasumsikan oleh katalog gabungan untuk mengakses AWS Glue Data Catalog. |
SnowflakeCatalogInfo
Informasi khusus untuk Snowflake Horizon Catalog. Endpoint Katalog REST Iceberg memiliki format: https://<accountIdentifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<warehouse>.
| Representasi JSON |
|---|
{ "account-identifier": string, "warehouse": string, "snowflake-role": string } |
| Kolom | |
|---|---|
account-identifier |
Wajib. Tidak dapat diubah. ID akun di Snowflake. Misalnya, untuk URL deployment Snowflake ID akun dapat berisi huruf, angka, dan garis bawah, dengan segmen yang dipisahkan oleh tanda hubung ( |
warehouse |
Wajib. Tidak dapat diubah. Nama database di Snowflake Horizon Catalog. |
snowflake-role |
Opsional. Peran Snowflake yang digunakan untuk mencakup akses ke Snowflake Horizon Catalog dalam alur autentikasi Workload Identity Federation (OIDC). |
WorkdayCatalogInfo
Informasi khusus untuk Workday Data Lake. Endpoint Katalog REST Iceberg memiliki format: https://<baseUrl>/datalake/api/catalog/v1/config?warehouse=workday.
| Representasi JSON |
|---|
{ "base-url": string, "tenant": string, "api-client-client-id": string } |
| Kolom | |
|---|---|
base-url |
Wajib. Tidak dapat diubah. URL dasar instance Workday. Misalnya |
tenant |
Wajib. Tidak dapat diubah. Nama tenant Workday. |
api-client-client-id |
Opsional. Client ID klien API Workday yang digunakan untuk mengakses Workday Data Lake dalam alur autentikasi OIDC. |
IdentityMode
Mode identitas yang digunakan oleh katalog untuk kueri.
| Enum | |
|---|---|
IDENTITY_MODE_UNSPECIFIED |
Nilai default/tidak ditetapkan. Nilai ini diperlakukan sama dengan IDENTITY_MODE_SERVICE_IDENTITY. |
IDENTITY_MODE_SERVICE_IDENTITY |
Kueri dijalankan menggunakan akun layanan di google.cloud.biglake.v1main.IcebergCatalog.biglake_service_account. |
IDENTITY_MODE_USER_IDENTITY_FEDERATION |
Kueri dijalankan menggunakan identitas pengguna akhir dan diterapkan ke katalog jarak jauh. Federasi identitas harus dikonfigurasi di katalog jarak jauh. Lihat https://docs.cloud.google.com/lakehouse/docs/about-cross-cloud-data-access#identity-mode untuk mengetahui detail selengkapnya. |
UserIdentityFederationOidcClaims
Klaim OIDC yang dikeluarkan dalam token ID saat IDENTITY_MODE_USER_IDENTITY_FEDERATION diaktifkan.
Nilai ini mengidentifikasi penyedia identitas (penerbit) dan penerima yang dituju (audiens) token. Untuk mengaktifkan penggabungan identitas pengguna, pengguna harus mengonfigurasi katalog jarak jauh mereka agar memercayai penerbit ini dan mengharapkan audiens ini.
| Representasi JSON |
|---|
{ "issuer-url": string, "audience": string } |
| Kolom | |
|---|---|
issuer-url |
Hanya output. URL penerbit penyedia identitas. |
audience |
Hanya output. Audiens yang diharapkan katalog ini dalam token. |
UserIdentityFederationOidc
Konfigurasi OIDC yang digunakan saat IDENTITY_MODE_USER_IDENTITY_FEDERATION diaktifkan.
Untuk mengaktifkan penggabungan identitas pengguna, pengguna harus mengonfigurasi katalog jarak jauh mereka agar memercayai token dengan parameter ini.
| Representasi JSON |
|---|
{ "issuer-url": string, "audience": string, "jwks-url": string } |
| Kolom | |
|---|---|
issuer-url |
Hanya output. URL penerbit penyedia identitas. |
audience |
Hanya output. Audiens yang diharapkan katalog ini dalam token. |
jwks-url |
Hanya output. URL JSON Web Key Set (JWKS) yang menyajikan kunci publik yang digunakan untuk memverifikasi token. Hanya ditetapkan untuk katalog gabungan Snowflake Horizon, yang digunakan sebagai |
RefreshOptions
Memuat ulang konfigurasi.
| Representasi JSON |
|---|
{ "refresh-schedule": { object ( |
| Kolom | |
|---|---|
refresh-schedule |
Opsional. Jadwal menentukan apakah dan kapan pemuatan ulang metadata harus dijadwalkan. |
refresh-scope |
Opsional. Memperbarui konfigurasi cakupan. |
RefreshSchedule
Jadwal menentukan apakah dan kapan pemuatan ulang metadata harus dijadwalkan.
| Representasi JSON |
|---|
{ "refresh-interval": string } |
| Kolom | |
|---|---|
refresh-interval |
Opsional. Interval untuk memuat ulang metadata dari katalog jarak jauh. Jika tidak disetel atau jika nilainya <= 0, pemuatan ulang metadata latar belakang akan dinonaktifkan. Jika kolom ini diperbarui untuk katalog gabungan yang ada, pemuatan ulang metadata latar belakang sebelumnya harus selesai sebelum interval pemuatan ulang baru berlaku. Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan ' |
RefreshScope
Cakupan menentukan subset namespace yang akan di-refresh.
| Representasi JSON |
|---|
{ "namespace-filters": [ string ] } |
| Kolom | |
|---|---|
namespace-filters[] |
Opsional. Filter untuk menentukan namespace mana yang disertakan dalam proses refresh. - daftar kosong berarti menyertakan semua namespace. - "[namespaces]" berarti menyertakan namespace yang ditentukan. ['ns1', 'ns2'] : Hanya temukan namespace 'ns1' dan 'ns2'. |
RefreshStatus
Status pembaruan metadata latar belakang katalog jarak jauh.
| Representasi JSON |
|---|
{
"start-time": string,
"end-time": string,
"status": {
object ( |
| Kolom | |
|---|---|
start-time |
Hanya output. Saat pembaruan katalog telah dimulai, termasuk pembaruan yang sedang berlangsung. Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
end-time |
Hanya output. Setelah pemuatan ulang katalog berakhir, batalkan penetapan untuk pemuatan ulang yang sedang berlangsung. Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
status |
Hanya output. Status operasi pembaruan metadata latar belakang terakhir, tidak ditetapkan untuk pembaruan yang sedang berlangsung. |
CrossCloudCacheOptions
Opsi konfigurasi untuk penyimpanan dalam cache lintas cloud untuk file data dan metadata.
| Representasi JSON |
|---|
{ "enabled": boolean } |
| Kolom | |
|---|---|
enabled |
Opsional. Menentukan apakah caching lintas cloud untuk file data dan metadata diaktifkan. Hal ini hanya memengaruhi kueri melalui BigQuery. Jika nilai ini adalah Jika nilai ini adalah |
Metode |
|
|---|---|
|
Membuat Katalog REST Iceberg. |
|
Menghapus Katalog REST Iceberg. |
|
Melakukan failover katalog ke region replika utama baru. |
|
Menampilkan opsi konfigurasi Katalog REST Iceberg. |
|
Mencantumkan Katalog REST Iceberg. |
|
Perbarui opsi konfigurasi Katalog REST Iceberg. |