REST Resource: deltasharing.v1.projects.catalogs

リソース: DeltaSharingCatalog

DeltaSharing カタログを表します。

JSON 表現 
{
  "name": string,
  "location": string,
  "createTime": string,
  "updateTime": string,
  "serviceAccount": string,
  "refreshOptions": {
    object (RefreshOptions)
  },
  "refreshStatus": {
    object (RefreshStatus)
  },
  "federatedCatalogOptions": {
    object (FederatedCatalogOptions)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "sapConfig": {
    object (SapConfig)
  }
  // End of mutually exclusive fields.
  "encryptionConfig": {
    object (EncryptionConfig)
  }
}
フィールド
name

string

ID。リソース名。形式: projects/{project}/catalogs/{catalog}
location

string

必須。変更不可。ユーザーが指定したカタログの GCP ロケーション。このフィールドは変更できません。
createTime

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"。
updateTime

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"。
serviceAccount

string

出力専用。SAP 登録に使用されるサービス アカウント。Delta Sharing カタログ リソースの作成の副作用として作成されます。
refreshOptions

object (RefreshOptions)

省略可。Delta Sharing カタログを更新するためのオプションを構成します。
refreshStatus

object (RefreshStatus)

出力専用。バックグラウンド カタログ更新のステータス。
federatedCatalogOptions

object (FederatedCatalogOptions)

省略可。連携カタログの構成オプション。
カタログの構成。1 つのフィールドだけを設定する必要があります。このフィールドによってカタログのタイプが決まります。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
sapConfig

object (SapConfig)

省略可。SAP Business Data Cloud（BDC）に接続するカタログの構成。
相互に排他的なフィールドの終わり。
encryptionConfig

object (EncryptionConfig)

省略可。カスタム暗号化構成（Cloud KMS 鍵など）。

SapConfig

SAP Business Data Cloud（BDC）の構成。

JSON 表現 
{
  "sapBdcEnrollmentConfig": {
    object (SapBdcEnrollmentConfig)
  },
  "sapRegion": string
}
フィールド
sapBdcEnrollmentConfig

object (SapBdcEnrollmentConfig)

省略可。SAP BDC に接続するカタログ リソースを作成するには、次の 3 つの手順を行います。1. SapConfig を空に設定します。これにより、GCP サービス アカウント serviceAccount を含むカタログ リソースが作成されます。2. SAP BDC インスタンスで、この serviceAccount を使用して登録プロセスを行い、BDC コネクタを作成します。SAP から connectorEndpoint と invitationCode が届きます。3. SAP から提供されたこれらの追加フィールドを使用して、前に作成した BigLake カタログ リソースを SapBdcEnrollmentConfig で更新します。SapBdcEnrollmentConfig を設定すると、変更できなくなります。
sapRegion

string

省略可。変更不可。SAP BDC API に使用する GCP リージョン。カタログのメタデータがマルチリージョン（「us」など）に保存され、物理 SAP BDC インスタンスが単一リージョン（「us-central1」など）に存在する場合、このフィールドを明示的に設定して、その単一リージョンを指すようにする必要があります。設定されていない場合は、カタログの作成時に指定されたロケーションがデフォルトで使用されます。

SapBdcEnrollmentConfig

SAP から受信した登録構成が含まれます。

JSON 表現 
{
  "connectorEndpoint": string,
  "invitationCode": string,
  "invitationUrl": string,
  "federatedIdentityIssuer": string
}
フィールド
connectorEndpoint

string

省略可。一意の SAP BDC コネクタ エンドポイント。
invitationCode

string

省略可。SAP からの招待コード。
invitationUrl

string

省略可。エンドポイントとコードの両方を含む招待 URL を組み合わせたもの。
federatedIdentityIssuer

string

出力専用。Lakehouse は、SAP BDC とのデータ プロダクトの共有をサポートしています。共有が有効になっている場合、SAP BDC はフェデレーション ID を介して基盤となるリソースにアクセスします。このフィールドは、フェデレーション ID の発行者を示します。

具体的には、ID プールとプロバイダは次のように作成する必要があります。

$ gcloud iam workload-identity-pools create sap-bdc-pool \ --location="global" \ --display-name="SAP BDC Pool"

$ gcloud iam workload-identity-pools providers create-oidc sap-bdc-provider \ --location="global" \ --workload-identity-pool="sap-bdc-pool" \ --issuer-uri=""

次に、SAP BDC がアクセスできるように、プールを共有リソースの IAM ポリシーに追加する必要があります。

$ gcloud projects add-iam-policy-binding PROJECT_ID \ --role="roles/biglake.viewer" \ --member="principal://iam.googleapis.com/projects/{PROJECT_NUMBER}/locations/global/workloadIdentityPools/sap-bdc-pool/subject/{TENANT_UUID}"

... ここで、TENANT_UUID は SAP BDC インスタンスで確認できます。

RefreshOptions

Delta Sharing カタログを更新するためのオプションを構成します。

JSON 表現 
{
  "refreshSchedule": {
    object (RefreshSchedule)
  }
}
フィールド
refreshSchedule

object (RefreshSchedule)

省略可。メタデータの更新をスケジュールするかどうか、またスケジュールする場合のタイミングを定義します。

RefreshSchedule

メタデータの更新をスケジュールするかどうか、またスケジュールする場合のタイミングを定義します。

JSON 表現 
{
  "refreshInterval": string
}
フィールド
refreshInterval

string (Duration format)

省略可。リモート カタログからメタデータを更新する間隔。設定されていないが更新が必要な場合は、システムのデフォルトが使用されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

RefreshStatus

リモート カタログのバックグラウンド更新ステータス。

JSON 表現 
{
  "startTime": string,
  "endTime": string,
  "status": {
    object (Status)
  }
}
フィールド
startTime

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"。
endTime

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"。
status

object (Status)

出力専用。最後のバックグラウンド更新オペレーションのステータス。進行中の更新の場合は設定されません。

FederatedCatalogOptions

連携カタログの構成オプション。

JSON 表現 
{
  "serviceDirectoryName": string,
  "crossCloudCacheOptions": {
    object (CrossCloudCacheOptions)
  }
}
フィールド
serviceDirectoryName

string

省略可。Cross-Cloud Interconnect を使用してプライベート ネットワーク接続でトラフィックをルーティングするためのサービス ディレクトリ リソース名（projects/{projectId}/locations/{locationId}/namespaces/{namespace_id}/services/{serviceId} 形式）。
crossCloudCacheOptions

object (CrossCloudCacheOptions)

省略可。データファイルとメタデータ ファイルのクロス クラウド キャッシュ保存の構成オプション。

CrossCloudCacheOptions

データファイルとメタデータ ファイルのクロス クラウド キャッシュ保存の構成オプション。

JSON 表現 
{
  "enabled": boolean
}
フィールド
enabled

boolean

省略可。データファイルとメタデータ ファイルのクロスクラウド キャッシュ保存を有効にするかどうかを指定します。これは BigQuery を介したクエリにのみ影響します。

この値が true の場合、読み取りデータとメタデータがキャッシュに保存されます。これにより、パフォーマンスが向上し、クロスクラウド クエリのネットワーク下り（外向き）費用が削減されます。

この値が false の場合、クロスクラウド キャッシュ保存は無効になります。

EncryptionConfig

カスタム暗号化構成（Cloud KMS 鍵など）。

JSON 表現 
{
  "kmsKeyName": string
}
フィールド
kmsKeyName

string

省略可。カタログから取得したキャッシュデータの暗号化に使用される Cloud KMS 鍵の名前。形式: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

メソッド

create

 新しい DeltaSharing カタログを作成します。

delete

 リソース名で指定された既存の DeltaSharing カタログを削除します。

get

 リソース名で指定されたカタログを取得します。

list

 指定されたプロジェクトのすべての Delta Sharing カタログを一覧表示します。

patch

 既存の DeltaSharing カタログを更新します。