- リソース: IcebergCatalog
- CredentialMode
- CatalogType
- Replica
- State
- RestrictedLocationsConfig
- EncryptionConfig
- FederatedCatalogOptions
- IdentityFederationOrganizationServiceAccount
- UnityCatalogInfo
- GlueCatalogInfo
- SnowflakeCatalogInfo
- WorkdayCatalogInfo
- IdentityMode
- UserIdentityFederationOidcClaims
- UserIdentityFederationOidc
- RefreshOptions
- RefreshSchedule
- RefreshScope
- RefreshStatus
- CrossCloudCacheOptions
- メソッド
リソース: IcebergCatalog
Iceberg REST カタログの情報。
| JSON 表現 |
|---|
{ "name": string, "credential-mode": enum ( |
| フィールド | |
|---|---|
name |
ID。カタログ名 |
credential-mode |
省略可。カタログの認証情報モード。 |
biglake-service-account |
出力専用。認証情報の提供に使用されるサービス アカウント(出力専用)。カタログで認証情報ベンディングが有効になっていない場合は、空になることがあります。 連携カタログの場合、サービス アカウントは常にプロビジョニングされ、バックグラウンド メタデータの更新のためにリモート カタログにアクセスするために使用されます。 |
biglake-service-account-id |
出力専用。サービス アカウントの一意の ID。これは、連携シナリオで使用されます。 |
catalog-type |
必須。カタログタイプ。catalogs.create に必要です。カタログタイプは不変です。ただし、CATALOG_TYPE_GCS_BUCKET から CATALOG_TYPE_BIGLAKE への変換は除きます。 |
default-location |
省略可。カタログのデフォルトのストレージ ロケーション(例: BigLake カタログの場合、このフィールドは必須で、Google Cloud Storage バケットまたはそのバケット内のパスを指す必要があります。このパスは、名前空間レベルまたはテーブルレベルでロケーションが指定されていない場合に、テーブルのデータ ディレクトリとメタデータ ディレクトリへのフルパスを構築するためのベース ディレクトリとして機能します。完全なパスは、デフォルトの場所に名前空間とテーブル識別子を追加して形成されます。 |
storage-regions[] |
出力専用。デフォルトのロケーションのバケットの Google Cloud リージョン( |
create-time |
出力専用。カタログが作成された日時。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
update-time |
出力専用。カタログが最後に更新された日時。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
replicas[] |
出力専用。カタログ メタデータのレプリカ。 |
description |
省略可。ユーザーが指定したカタログの説明。説明は 1,024 文字以内の UTF-8 文字列にする必要があります。 |
restricted-locations-config |
省略可。制限付きロケーションの構成。このフィールドは現在、BigLake カタログでのみ使用されています。 このフィールドが未設定の場合、または |
federated-catalog-options |
省略可。連携カタログの構成オプション。 |
cross-cloud-cache-options |
省略可。データファイルとメタデータ ファイルのクロスクラウド キャッシュの構成オプション。 |
encryption-config |
省略可。カスタム暗号化構成(Cloud KMS 鍵など)。 |
CredentialMode
カタログに使用される認証情報モード。
| 列挙型 | |
|---|---|
CREDENTIAL_MODE_UNSPECIFIED |
デフォルト値 / 未設定値。この値は使用されません。 |
CREDENTIAL_MODE_END_USER |
エンドユーザー認証情報モード(デフォルト)。認証ユーザーは、カタログ リソースと基盤となる Google Cloud Storage オブジェクトにアクセスできる必要があります。 |
CREDENTIAL_MODE_VENDED_CREDENTIALS |
認証情報ベンディング モード。認証ユーザーはカタログ リソースにアクセスするだけで、システムは呼び出し元に Google Cloud Storage オブジェクトにアクセスするためのダウンスコープされた認証情報を提供します。このモードのすべてのテーブル オペレーションでは、 詳細については、https://docs.cloud.google.com/lakehouse/docs/credential-vending をご覧ください。 |
CatalogType
カタログタイプを決定します。
| 列挙型 | |
|---|---|
CATALOG_TYPE_UNSPECIFIED |
デフォルト値 / 未設定値。この値は使用されません。 |
CATALOG_TYPE_GCS_BUCKET |
Google Cloud Storage バケットのカタログタイプ。 |
CATALOG_TYPE_BIGLAKE |
BigLake カタログのタイプ。 |
CATALOG_TYPE_FEDERATED |
連携カタログのタイプ。 |
CATALOG_TYPE_ALLOYDB_AGENT_MODE |
エージェント モードで AlloyDB テーブルをクエリするためのカタログ。 |
レプリカ
カタログのレプリカ。
| JSON 表現 |
|---|
{
"region": string,
"state": enum ( |
| フィールド | |
|---|---|
region |
出力専用。レプリカのリージョン。例: 「us-east1」 |
state |
出力専用。レプリカの現在の状態。 |
状態
カタログが複数のリージョンに複製されている場合、この列挙型はレプリカの現在の状態を表します。
| 列挙型 | |
|---|---|
STATE_UNKNOWN |
デフォルト値 / 未設定値。この値は使用されません。 |
STATE_PRIMARY |
レプリカは書き込み可能なプライマリです。 |
STATE_PRIMARY_IN_PROGRESS |
レプリカは最近プライマリとして割り当てられましたが、すべての名前空間が書き込み可能になっているわけではありません。 |
STATE_SECONDARY |
レプリカは読み取り専用のセカンダリ レプリカです。 |
RestrictedLocationsConfig
ロケーション制限の構成。
| JSON 表現 |
|---|
{ "restricted-locations": [ string ] } |
| フィールド | |
|---|---|
restricted-locations[] |
省略可。カタログ内のリソースで使用が許可されている追加の Google Cloud Storage バケットとロケーション(
|
EncryptionConfig
カスタム暗号化構成(Cloud KMS 鍵など)。
| JSON 表現 |
|---|
{ "kms-key-name": string } |
| フィールド | |
|---|---|
kms-key-name |
省略可。カタログから取得したキャッシュ データの暗号化に使用される Cloud KMS 鍵の名前。形式: |
FederatedCatalogOptions
連携カタログの構成オプション。
| JSON 表現 |
|---|
{ "identity-mode": enum ( |
| フィールド | |
|---|---|
identity-mode |
省略可。連携カタログの ID モード。 |
refresh-options |
省略可。構成を更新します。 |
refresh-status |
出力専用。バックグラウンド メタデータ更新オペレーションのステータス。 |
| 相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
identity-federation-organization-service-account |
出力専用。ID 連携に使用される組織レベルのサービス アカウント。 |
| 相互に排他的なフィールドの終了。 | |
| リモート Iceberg REST カタログに固有の情報。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
unity-catalog-info |
省略可。Databricks Unity Catalog に固有の情報。 |
glue-catalog-info |
省略可。AWS Glue Data Catalog に固有の情報。 |
snowflake-catalog-info |
省略可。Snowflake Horizon カタログに固有の情報。 |
workday-catalog-info |
省略可。Workday Data Lake に固有の情報。 |
| 相互に排他的なフィールドの終了。 | |
secret-name |
省略可。Secret Manager の Secret リソース名( プロジェクト ID はカタログのプロジェクトと一致し、ロケーションはカタログのロケーションと一致する必要があります。バージョンが指定されていない場合は、最新バージョンが使用されます。 このフィールドは、 |
service-directory-name |
省略可。プライベート ネットワーク接続を介してリモート カタログ(ストレージ バケット内のデータファイル アクセスなど)と通信するトランスポート層トラフィックをルーティングするために使用される Service Directory リソース名。 形式: このリソース名は、BigQuery クエリが Cross-Cloud Interconnect などのプライベート ネットワーク接続を介してデータファイル(S3 や Azure データレイク ストレージの Iceberg データなど)を取得する際に、プライベート エンドポイントの名前を解決するために使用されます。 |
metadata-service-directory-name |
省略可。プライベート ネットワーク接続を介してリモート カタログと通信するメタデータ レイヤ トラフィックをルーティングするために使用される Service Directory リソース名。 形式: Cross-Cloud Interconnect などのプライベート ネットワーク接続を介してカタログ メタデータ(Iceberg 構成、名前空間、テーブルなど)を取得するために使用されます。 |
user-identity-federation-oidc-claims |
出力専用。非推奨: 代わりに、 ユーザー ID 連携の ID トークンで出力される OIDC クレーム。 |
user-identity-federation-oidc |
出力専用。ユーザー ID 連携の OIDC 構成。 |
IdentityFederationOrganizationServiceAccount
ID 連携に使用される組織レベルのサービス アカウント(出力専用)。カタログで ID 連携が有効になっていない場合は、空になることがあります。
| JSON 表現 |
|---|
{ "service-account": string, "service-account-unique-id": string } |
| フィールド | |
|---|---|
service-account |
出力専用。組織レベルのサービス アカウントのメールアドレス。 |
service-account-unique-id |
出力専用。組織レベルのサービス アカウントの一意の ID。 |
UnityCatalogInfo
Databricks Unity Catalog に固有の情報。Iceberg REST カタログのエンドポイントの形式は https://<instanceName>/api/2.1/unity-catalog/iceberg-rest/v1/config?warehouse=<catalogName> です。
| JSON 表現 |
|---|
{ "instance-name": string, "catalog-name": string, "service-principal-application-id": string } |
| フィールド | |
|---|---|
instance-name |
必須。変更不可。Databricks ワークスペースのインスタンス名。たとえば、Databricks ワークスペースの URL が |
catalog-name |
必須。変更不可。Databricks Unity Catalog のカタログの名前。 |
service-principal-application-id |
省略可。OIDC 認証フローで Databricks Unity Catalog にアクセスするために使用する Databricks サービス プリンシパルのアプリケーション ID。 |
GlueCatalogInfo
AWS Glue Data Catalog に固有の情報。Iceberg REST カタログのエンドポイントの形式は https://glue.<awsRegion>.amazonaws.com/iceberg/v1/config?warehouse=<warehouse> です。
| JSON 表現 |
|---|
{ "warehouse": string, "aws-region": string, "aws-role-arn": string } |
| フィールド | |
|---|---|
warehouse |
必須。変更不可。AWS Glue Data Catalog のウェアハウスのロケーション。 デフォルトのアカウント カタログの場合は、12 桁の AWS アカウント ID を使用します(例: |
aws-region |
必須。変更不可。AWS Glue Data Catalog の AWS リージョン(例: |
aws-role-arn |
必須。AWS Glue Data Catalog にアクセスするために連携カタログが引き受ける AWS IAM ロールの Amazon リソースネーム(ARN)。 |
SnowflakeCatalogInfo
Snowflake Horizon カタログに固有の情報。Iceberg REST カタログのエンドポイントの形式は https://<accountIdentifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<warehouse> です。
| JSON 表現 |
|---|
{ "account-identifier": string, "warehouse": string, "snowflake-role": string } |
| フィールド | |
|---|---|
account-identifier |
必須。変更不可。Snowflake のアカウント ID。たとえば、Snowflake デプロイ URL が アカウント ID には、英字、数字、アンダースコアを使用できます。セグメントはハイフン( |
warehouse |
必須。変更不可。Snowflake Horizon カタログのデータベース名。 |
snowflake-role |
省略可。Workload Identity 連携(OIDC)認証フローで Snowflake Horizon カタログへのアクセスをスコープするために使用される Snowflake ロール。 |
WorkdayCatalogInfo
Workday Data Lake に固有の情報。Iceberg REST カタログのエンドポイントの形式は https://<baseUrl>/datalake/api/catalog/v1/config?warehouse=workday です。
| JSON 表現 |
|---|
{ "base-url": string, "tenant": string, "api-client-client-id": string } |
| フィールド | |
|---|---|
base-url |
必須。変更不可。Workday インスタンスのベース URL。たとえば、 |
tenant |
必須。変更不可。Workday のテナント名。 |
api-client-client-id |
省略可。OIDC 認証フローで Workday Data Lake へのアクセスに使用される Workday API クライアントのクライアント ID。 |
IdentityMode
カタログがクエリに使用する ID モード。
| 列挙型 | |
|---|---|
IDENTITY_MODE_UNSPECIFIED |
デフォルト値 / 未設定値。この値は IDENTITY_MODE_SERVICE_IDENTITY と同じように扱われます。 |
IDENTITY_MODE_SERVICE_IDENTITY |
クエリは、google.cloud.biglake.v1main.IcebergCatalog.biglake_service_account のサービス アカウントを使用して実行されます。 |
IDENTITY_MODE_USER_IDENTITY_FEDERATION |
クエリをエンドユーザー ID で実行し、リモート カタログに伝播します。リモート カタログに ID 連携が構成されている必要があります。 詳細については、https://docs.cloud.google.com/lakehouse/docs/about-cross-cloud-data-access#identity-mode をご覧ください。 |
UserIdentityFederationOidcClaims
IDENTITY_MODE_USER_IDENTITY_FEDERATION が有効になっているときに ID トークンで出力される OIDC クレーム。
これらの値は、トークンの ID プロバイダ(発行者)と対象の受信者(オーディエンス)を識別します。ユーザー ID 連携を有効にするには、この発行者を信頼し、このオーディエンスを想定するようにリモート カタログを構成する必要があります。
| JSON 表現 |
|---|
{ "issuer-url": string, "audience": string } |
| フィールド | |
|---|---|
issuer-url |
出力専用。ID プロバイダの発行元 URL。 |
audience |
出力専用。このカタログがトークンで想定するオーディエンス。 |
UserIdentityFederationOidc
IDENTITY_MODE_USER_IDENTITY_FEDERATION が有効になっているときに使用される OIDC 構成。
ユーザー ID 連携を有効にするには、これらのパラメータを持つトークンを信頼するようにリモート カタログを構成する必要があります。
| JSON 表現 |
|---|
{ "issuer-url": string, "audience": string, "jwks-url": string } |
| フィールド | |
|---|---|
issuer-url |
出力専用。ID プロバイダの発行元 URL。 |
audience |
出力専用。このカタログがトークンで想定するオーディエンス。 |
jwks-url |
出力専用。トークンの検証に使用される公開鍵を提供する JSON Web Key Set(JWKS)の URL。Snowflake Horizon 連携カタログにのみ設定されます。Snowflake セキュリティ統合で |
RefreshOptions
構成を更新します。
| JSON 表現 |
|---|
{ "refresh-schedule": { object ( |
| フィールド | |
|---|---|
refresh-schedule |
省略可。schedule は、メタデータの更新をスケジュールするかどうか、およびスケジュールする場合のタイミングを定義します。 |
refresh-scope |
省略可。スコープ構成を更新します。 |
RefreshSchedule
schedule は、メタデータの更新をスケジュールするかどうか、およびスケジュールする場合のタイミングを定義します。
| JSON 表現 |
|---|
{ "refresh-interval": string } |
| フィールド | |
|---|---|
refresh-interval |
省略可。リモート カタログからメタデータを更新する間隔。未設定の場合、または値が 0 以下の場合は、バックグラウンドでのメタデータの更新が無効になります。既存の連携カタログでこのフィールドが更新された場合、新しい更新間隔が有効になる前に、以前のバックグラウンド メタデータの更新が完了している必要があります。
|
RefreshScope
スコープは、更新する名前空間のサブセットを定義します。
| JSON 表現 |
|---|
{ "namespace-filters": [ string ] } |
| フィールド | |
|---|---|
namespace-filters[] |
省略可。更新プロセスに含める名前空間を決定するフィルタ。- 空のリストは、すべての Namespace を含めることを意味します。- "[namespaces]" は、指定された名前空間を含めることを意味します。['ns1', 'ns2'] : 名前空間「ns1」と「ns2」のみを検出します。 |
RefreshStatus
リモート カタログのバックグラウンド メタデータ更新ステータス。
| JSON 表現 |
|---|
{
"start-time": string,
"end-time": string,
"status": {
object ( |
| フィールド | |
|---|---|
start-time |
出力専用。カタログの更新が開始されたとき(進行中の更新を含む)。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
end-time |
出力専用。カタログの更新が終了したら、進行中の更新の設定を解除します。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
status |
出力専用。最後のバックグラウンド メタデータ更新オペレーションのステータス。進行中の更新の場合は未設定。 |
CrossCloudCacheOptions
データファイルとメタデータ ファイルのクロスクラウド キャッシュの構成オプション。
| JSON 表現 |
|---|
{ "enabled": boolean } |
| フィールド | |
|---|---|
enabled |
省略可。データファイルとメタデータ ファイルのクロスクラウド キャッシュを有効にするかどうかを指定します。これは BigQuery を介したクエリにのみ影響します。 この値が この値が |
メソッド |
|
|---|---|
|
Iceberg REST カタログを作成します。 |
|
Iceberg REST カタログを削除します。 |
|
カタログを新しいプライマリ レプリカ リージョンにフェイルオーバーします。 |
|
Iceberg REST カタログの構成オプションを返します。 |
|
Iceberg REST カタログを一覧表示します。 |
|
Iceberg REST カタログの構成オプションを更新します。 |