REST Resource: iceberg.v1.restcatalog.extensions.projects.catalogs

string

ID。目錄名稱，projects/my-project/catalogs/my-catalog。這個欄位無法變更。如果是目錄建立作業，系統會忽略這個欄位。

enum (CredentialMode)

選用。目錄的憑證模式。

string

僅供輸出。用於憑證販售的服務帳戶，僅供輸出。如果目錄從未啟用憑證販售功能，這個欄位可能為空白。對於聯合目錄，系統一律會佈建服務帳戶，並使用 Secret Manager 密鑰或身分聯合存取權，存取遠端 Iceberg REST 目錄。

string

僅供輸出。服務帳戶的專屬 ID。這適用於同盟情境。

enum (CatalogType)

這是必要旗標，目錄類型。目錄建立作業需要這項資訊。目錄類型不可變動，但可從 CATALOG_TYPE_GCS_BUCKET 轉換為 CATALOG_TYPE_BIGLAKE。

string

選用。目錄的預設儲存位置，例如 gs://my-bucket。如果是 Google Cloud Storage 值區目錄，則僅為輸出內容。

如果是 BigLake 目錄，則必須提供這個欄位，並指向 Google Cloud Storage bucket 或該 bucket 內的路徑。如果未在命名空間或資料表層級指定位置，這個路徑會做為建構資料表資料和中繼資料目錄完整路徑的基礎目錄。完整路徑是將命名空間和資料表 ID 附加至預設位置而形成。

string

僅供輸出。預設位置 bucket 的 Google Cloud 區域，例如 us-central1、nam4 或 us。除了設定為使用自訂雙區域值區的目錄外，這項屬性會包含所有位置的值。如果是自訂雙區域值區，則會包含值區的兩個區域。這個欄位的區域應位於目錄主要位置的管轄範圍內或附近。

string (Timestamp format)

僅供輸出。目錄的建立時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

string (Timestamp format)

僅供輸出。上次更新目錄的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

object (Replica)

僅供輸出。目錄中繼資料的副本。

string

選用。使用者提供的目錄說明。說明必須是 UTF-8 字串，長度上限為 1024 個字元。

object (RestrictedLocationsConfig)

選用。設定受限制的位置。這個欄位目前僅用於 BigLake 目錄。

如果未設定這個欄位，或 restrictedLocationsConfig.restricted_locations 為空白，系統會允許所有可存取的位置。如果 restrictedLocationsConfig.restricted_locations 不為空白，則只能使用 defaultLocation 和 restrictedLocationsConfig.restricted_locations 中的位置。

object (FederatedCatalogOptions)

選用。聯合目錄的設定選項。

string

僅供輸出。副本的區域。例如「us-east1」

enum (State)

僅供輸出。副本的目前狀態。

string

選用。目錄中資源可使用的其他 Google Cloud Storage bucket 和位置 (例如 gs://my-other-bucket/...)。這個欄位目前僅用於 BigLake 目錄。

如果 restrictedLocations 為空白，且已啟用無限制的目錄建立功能，系統會允許所有可存取的位置。否則，只能使用 defaultLocation 和這份清單中的位置。

object (RefreshOptions)

選用。重新整理設定。

object (RefreshStatus)

僅供輸出。背景重新整理作業的狀態。

object (UnityCatalogInfo)

選用。Databricks Unity Catalog 的專屬資訊。

object (GlueCatalogInfo)

選用。AWS Glue Catalog 專屬資訊。

object (SnowflakeCatalogInfo)

選用。Snowflake 目錄專屬資訊。

string

選用。Secret Manager 中的密鑰資源名稱，格式為 projects/{projectId}/locations/{location}/secrets/{secret_id} 或 projects/{projectId}/locations/{location}/secrets/{secret_id}/versions/{version_id}。

專案 ID 必須與目錄的專案相符，位置也必須與目錄的位置相符。如未指定版本，則會使用最新版本。

如果已設定 google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo.service_principal_application_id 或 google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.snowflake_role，系統不會使用這個欄位。

string

選用。Service Directory 資源名稱，用於透過 Cross-Cloud Interconnect 的私人網路連線轉送流量，格式為 projects/{projectId}/locations/{locationId}/namespaces/{namespace_id}/services/{serviceId}。

string

這是必要旗標，登入 Databricks 部署作業時，網址的第一部分就是執行個體名稱。舉例來說，如果 Google Cloud 中的 Databricks 工作區網址為 https://1.1.Google Cloud.databricks.com，執行個體名稱就是 1.1.Google Cloud.databricks.com。

string

這是必要旗標，Unity Catalog 中的目錄名稱。

string

選用。在 OIDC 驗證流程中，用於存取 Unity Catalog 的 Databricks 服務主體應用程式 ID。

string

這是必要旗標，不可變動。要連線至區域 AWS Glue Iceberg REST 目錄的倉儲。如要取得最高層級的存取權，請使用 AWS 帳戶 ID (例如 111222333444)。如果是 S3 資料表 bucket，倉庫的格式為：111222333444:s3tablescatalog/。存取目錄的網址為 https://glue.{awsRegion}.amazonaws.com/iceberg/v1?warehouse={warehouse}。不得為空值，且不可變動。

string

這是必要旗標，不可變動。要連線的 Glue 目錄 AWS 區域。該區域應與聯邦目錄位於相同地理區域和管轄範圍。不得為空值，且不可變動。

string

這是必要旗標，聯合目錄將承擔的 Glue 目錄 AWS 角色 ARN，用來存取目錄。不得為空白。可以更新。

string

這是必要旗標，Snowflake 中的帳戶 ID (請參閱：https://docs.snowflake.com/en/user-guide/admin-account-identifier)。這是登入 Snowflake 部署網址的前置字串。例如：https://.snowflakecomputing.com。

string

這是必要旗標，要連線至 Snowflake REST 目錄的倉儲。https://.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=.

這是包含要聯合的 Iceberg 中繼資料的 Snowflake 資料庫名稱。

不得為空白。

string

選用。要在 Iceberg REST 目錄工作階段的 OAuth 權杖範圍內要求的特定 Snowflake 角色名稱 (透過 session:role:$ROLE)。這個角色會授予 Google Cloud BigLake 服務帳戶必要權限，以便與 Iceberg 目錄、命名空間和資料表互動。

注意：這裡提供的角色須為 DEFAULT_ROLE，或是已授予對應至 BigLake 服務帳戶的 Snowflake 服務使用者。

object (RefreshSchedule)

選用。排程會定義是否應排定中繼資料重新整理作業，以及排定的時間。

object (RefreshScope)

選用。重新整理範圍設定。

string (Duration format)

選用。從遠端目錄重新整理中繼資料的時間間隔。如果未設定或值 <= 0，系統會停用背景重新整理功能。如果更新現有聯盟目錄的此欄位，必須先完成先前的背景重新整理，新的重新整理間隔才會生效。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。

string

選用。篩選器，用於決定要將哪些命名空間納入重新整理程序。- 空白清單表示包含所有命名空間。-「[namespaces]」表示納入指定的命名空間。['ns1', 'ns2']：只探索「ns1」和「ns2」命名空間。命名空間篩選器數量上限為 32 個。

string (Timestamp format)

僅供輸出。目錄重新整理作業的開始時間，包括正在進行的重新整理作業。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

string (Timestamp format)

僅供輸出。目錄重新整理作業結束後，請取消設定進行中的重新整理作業。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

object (Status)

僅供輸出。上次背景重新整理作業的狀態，如果重新整理作業正在進行中，則不會設定這個屬性。