- JSON 表現
- 都道府県
- SourceEntity
- SyncMode
- DestinationConfig
- 宛先
- ActionConfig
- EndUserConfig
- テナント
- FederatedConfig
- ConnectorMode
- BlockingReason
- IdentityScheduleConfig
- BAPConfig
- ConnectorMode
- ConnectorType
- AlertPolicyConfig
- AlertEnrollment
- EnrollStates
- RealtimeSyncConfig
- StreamingError
- StreamingErrorReason
Collection
にグループ化されたすべてのデータストアの外部データソースへの接続を管理します。これは Collection
のシングルトン リソースです。初期化は DataConnectorService.SetUpDataConnector
メソッドでのみサポートされます。このメソッドは新しい Collection
を作成し、その DataConnector
を初期化します。
JSON 表現 |
---|
{ "name": string, "state": enum ( |
フィールド | |
---|---|
name |
出力専用。データコネクタの完全なリソース名。形式: |
state |
出力専用。コネクタの状態。 |
dataSource |
必須。データソースの名前。サポートされる値: |
removeParamKeys[] |
省略可。「params」フィールドから削除するキーを指定します。これは、UpdateDataConnectorRequest の updateMask に params が含まれている場合にのみ有効になります。キーが removeParamKeys とリクエストの params フィールドの両方に存在する場合、削除が優先されます。 |
refreshInterval |
必須。データ同期の更新間隔。期間を 0 に設定すると、データはリアルタイムで同期されます。ストリーミング機能はまだサポートされていません。最小値は 30 分、最大値は 7 日です。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります。
|
nextSyncTime |
次のデータ同期のスケジュール時間を定義します。このフィールドには、IANA タイムゾーン データベースの hour、minute、timeZone が必要です。これは、データコネクタの更新間隔が 1 日を超える場合に使用されます。時間または分が指定されていない場合は、同期時間は 0:00 とみなされます。ユーザーは、あいまいさを避けるためにタイムゾーンを指定する必要があります。 |
entities[] |
接続されたデータソースから取り込むエンティティのリスト。 |
createTime |
出力専用。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
latestPauseTime |
出力専用。この RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
lastSyncTime |
出力専用。定期的なコネクタの場合のみ、データ同期が最後に完了した日時。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
updateTime |
出力専用。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
errors[] |
出力専用。初期化または最新のコネクタ実行からのエラー。 |
syncMode |
データコネクタでサポートされているデータ同期モード。 |
kmsKeyName |
入力専用。このコネクタで管理される DataStore の保護に使用される KMS 鍵。 CMEK 組織のポリシーの保護に準拠する必要があるリクエストに設定する必要があります。 このフィールドが設定され、正常に処理されると、このコネクタによって作成された DataStore は KMS 鍵で保護されます。 |
destinationConfigs[] |
省略可。サードパーティのサービスへの接続に使用されるターゲット宛先。 |
actionState |
出力専用。アクション コネクタの状態。これは、アクション コネクタが初期化中、アクティブ、またはエラーが発生したかどうかを反映します。 |
actionConfig |
省略可。コネクタがアクションをサポートするようにするアクション構成。 |
endUserConfig |
省略可。EUA コネクタ専用に使用されるパラメータと認証情報。 |
federatedConfig |
省略可。FEDERATED モードをサポートするハイブリッド コネクタ専用に使用されるパラメータと認証情報。このフィールドは、コネクタがハイブリッド コネクタで、フェデレーション モードを有効にする場合にのみ設定する必要があります。 |
connectorModes[] |
省略可。このコネクタで有効になっているモード。デフォルトの状態は CONNECTOR_MODE_UNSPECIFIED です。 |
staticIpEnabled |
省略可。お客様がこのコネクタで静的 IP アドレスを有効にしているかどうか。 |
staticIpAddresses[] |
出力専用。このコネクタで使用される静的 IP アドレス。 |
blockingReasons[] |
出力専用。コネクタがデータの同期を開始する前に完了する必要があるユーザー アクション。 |
identityRefreshInterval |
このコネクタによって取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔。設定しない場合、アクセス制御リストはデフォルトの 30 分間隔で更新されます。ID の更新間隔は、30 分から 7 日までの範囲で設定できます。
|
identityScheduleConfig |
ID データ同期の実行の構成。このコネクタで取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔が含まれます。 |
privateConnectivityProjectId |
出力専用。プライベート接続コネクタに関連付けられているテナント プロジェクト ID。コネクタが機能するには、このプロジェクトを許可リストに登録する必要があります。 |
bapConfig |
省略可。BAP 接続を確立するための構成。 |
connectorType |
出力専用。コネクタのタイプ。各ソースは 1 つのタイプにのみマッピングできます。たとえば、salesforce、confluence、jira のコネクタ タイプは THIRD_PARTY です。システムによって設定されると、変更できません。 |
realtimeState |
出力専用。リアルタイム同期の状態 |
alertPolicyConfigs[] |
省略可。コネクタレベルのアラート構成。 |
realtimeSyncConfig |
省略可。リアルタイム同期の構成。 |
aclEnabled |
省略可。コネクタが ACL 構成で作成されるかどうか。現在、このフィールドは Cloud Storage コネクタと BigQuery コネクタにのみ影響します。 |
createEuaSaas |
省略可。END USER AUTHENTICATION コネクタが SaaS で作成されているかどうか。 |
autoRunDisabled |
省略可。コネクタが自動実行で無効になっているかどうかを示します。定期的な同期とリアルタイム同期を一時停止するために使用できます。更新: incrementalSyncDisabled の導入により、autoRunDisabled は完全同期の一時停止/無効化にのみ使用されるようになりました |
incrementalSyncDisabled |
省略可。このコネクタの増分同期が一時停止されているかどうかを示します。これは autoRunDisabled とは独立しています。サードパーティ コネクタにのみ適用されます。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります(true に設定されます)。 |
incrementalRefreshInterval |
省略可。増分データ同期専用の更新間隔。設定されていない場合、増分同期では環境のデフォルト(3 時間)が使用されます。最小値は 30 分、最大値は 7 日です。サードパーティ コネクタにのみ適用されます。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります。
|
hybridIngestionDisabled |
省略可。コネクタがハイブリッド コネクタの場合、コネクタの作成時に取り込みが有効になり、適切なリソースがプロビジョニングされるかどうかを決定します。コネクタがハイブリッド コネクタでない場合、このフィールドは無視されます。 |
共用体フィールド すべてのデータソースで必須のパラメータ:
OAUTH をサポートするソース(
基本的な API トークン認証(
例:
複数の認証タイプをサポートするために使用する認証タイプを指定する省略可能なパラメータ:
|
|
params |
構造化された JSON 形式の必須データ コネクタ パラメータ。 |
jsonParams |
JSON 文字列形式の必須データ コネクタ パラメータ。 |
状態
コネクタの状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
デフォルト値。 |
CREATING |
コネクタを設定しています。 |
ACTIVE |
コネクタが正常に設定され、次回の同期実行を待機しています。 |
FAILED |
コネクタがエラー状態です。エラーの詳細は DataConnector.errors で確認できます。エラーを修正できない場合は、[CollectionService.DeleteCollection] API で DataConnector を削除できます。 |
RUNNING |
コネクタがデータソースからレコードをアクティブに同期しています。 |
WARNING |
コネクタは同期実行を完了しましたが、致命的でないエラーが発生しました。 |
INITIALIZATION_FAILED |
コネクタの初期化に失敗しました。考えられる原因としては、ランタイム エラーや非同期パイプラインの問題などがあります。これにより、リクエストがダウンストリーム サービスに到達できなくなります(一部のコネクタタイプを除く)。 |
UPDATING |
コネクタの更新中です。 |
SourceEntity
データソース内のエンティティを表します。たとえば、Salesforce の Account
オブジェクトなどです。
JSON 表現 |
---|
{ "entityName": string, "keyPropertyMappings": { string: string, ... }, "dataStore": string, "startingSchema": { object ( |
フィールド | |
---|---|
entityName |
エンティティの名前。データソース別のサポートされている値:
|
keyPropertyMappings |
インデックス登録用の属性。キー: フィールド名。値: フィールドをマッピングするキー プロパティ(
|
dataStore |
出力専用。ソース エンティティに関連付けられたデータストアの完全なリソース名。形式: |
startingSchema |
省略可。この SourceEntity から作成された このフィールドは [SetUpDataConnector][] API でのみ使用され、他の API で使用された場合は無視されます。このフィールドは、[GetDataConnector][] API を含むすべての API レスポンスから省略されます。 提供されたスキーマは、スキーマに関する特定のルールに対して検証されます。詳しくは、こちらのドキュメントをご覧ください。 |
healthcareFhirConfig |
省略可。 |
共用体フィールド
|
|
params |
構造化された JSON 形式でデータ取り込みを容易にするエンティティのパラメータ。 |
jsonParams |
JSON 文字列形式で、データ取り込みを容易にするエンティティのパラメータ。 |
SyncMode
データコネクタでサポートされているデータ同期モードを定義します。
列挙型 | |
---|---|
PERIODIC |
コネクタは、refreshInterval に基づいてデータを定期的に同期します。autoRunDisabled と組み合わせて使用すると、定期的な同期を一時停止したり、1 回限りの同期を指定したりできます。 |
STREAMING |
データはリアルタイムで同期されます。 |
UNSPECIFIED |
データを取り込まないコネクタにはこの値が設定されます |
DestinationConfig
サードパーティ ソースへの接続に使用されるターゲット エンドポイントを定義します。
JSON 表現 |
---|
{ "key": string, "destinations": [ { object ( |
フィールド | |
---|---|
key |
省略可。コネクタでサポートされている一意の宛先識別子。 |
destinations[] |
省略可。対応するキーの宛先。 |
共用体フィールド destination_config_params 。この宛先構成の追加パラメータ。destination_config_params は次のいずれかになります。 |
|
params |
省略可。この宛先構成の追加パラメータを構造化された JSON 形式で指定します。 |
jsonParams |
この宛先構成の追加パラメータ(JSON 文字列形式)。 |
目的地
ターゲット エンドポイントを定義します
JSON 表現 |
---|
{ "port": integer, // Union field |
フィールド | |
---|---|
port |
省略可。宛先で受け入れられたターゲット ポート番号。 |
共用体フィールド destination 。エンドポイントの宛先。destination は次のいずれかになります。 |
|
host |
一般公開されたルーティング可能なホスト。 |
ActionConfig
コネクタのアクションをサポートする情報。
JSON 表現 |
---|
{ "isActionConfigured": boolean, "serviceName": string, "useStaticSecrets": boolean, // Union field |
フィールド | |
---|---|
isActionConfigured |
出力専用。コネクタには必要なパラメータが含まれており、アクションをサポートするように構成されています。 |
serviceName |
省略可。 VPC Service Controls が有効な場合は必須です。 |
useStaticSecrets |
省略可。コネクタに静的シークレットを使用するかどうか。true の場合、actionParams で指定されたシークレットは無視されます。 |
共用体フィールド OAUTH をサポートするソース(
|
|
actionParams |
省略可。構造化された JSON 形式のアクション パラメータ。 |
jsonActionParams |
省略可。JSON 文字列形式のアクション パラメータ。 |
EndUserConfig
EUA コネクタ専用に使用されるパラメータと認証情報。
JSON 表現 |
---|
{ "additionalParams": { object }, "tenant": { object ( |
フィールド | |
---|---|
additionalParams |
省略可。EUA に必要な追加のパラメータ。 |
tenant |
省略可。コネクタが接続されているテナント プロジェクト。 |
共用体フィールド auth_config 。EUA コネクタの認証構成。auth_config は次のいずれかになります。 |
|
authParams |
省略可。EUA コネクタに固有の認証パラメータ。 |
jsonAuthParams |
省略可。EUA コネクタに固有の認証パラメータ(JSON 文字列形式)。 |
テナント
コネクタソースのテナント情報。これには、Credential メッセージに保存されている情報の一部が含まれますが、ユーザーにアクセス可能なテナントのリストを提供するために必要な情報のみに限定されます。
JSON 表現 |
---|
{ "id": string, "uri": string, "displayName": string } |
フィールド | |
---|---|
id |
テナントのインスタンス ID。例: Jira(「8594f221-9797-5f78-1fa4-485e198d7cd0」)、Slack(「T123456」)。 |
uri |
テナントの URI(該当する場合)。たとえば、Jira インスタンスの URI は https://my-jira-instance.atlassian.net です。Slack テナントには URI がありません。 |
displayName |
テナントのオプションの表示名(「My Slack Team」など)。 |
FederatedConfig
FEDERATED モードをサポートするハイブリッド コネクタ専用に使用されるパラメータと認証情報。
JSON 表現 |
---|
{ "additionalParams": { object }, // Union field |
フィールド | |
---|---|
additionalParams |
省略可。FEDERATED に必要な追加のパラメータ。 |
共用体フィールド auth_config 。FEDERATED コネクタの認証構成。auth_config は次のいずれかになります。 |
|
authParams |
省略可。FEDERATED コネクタに固有の認証パラメータ。 |
jsonAuthParams |
省略可。json 文字列形式の FEDERATED コネクタに固有の認証パラメータ。 |
ConnectorMode
このコネクタで有効になっているモード。INGESTION、ACTIONS、FEDERATED、EUA
列挙型 | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
コネクタモードが指定されていません。 |
DATA_INGESTION |
データ取り込みに使用されるコネクタ。 |
ACTIONS |
アクションに使用されるコネクタ。 |
FEDERATED |
連携検索に使用されるコネクタ。 |
EUA |
エンドユーザー認証に使用されるコネクタ。 |
FEDERATED_AND_EUA |
連携検索とエンドユーザー認証に使用されるハイブリッド コネクタ。 |
BlockingReason
コネクタがデータの同期を開始する前に完了する必要があるユーザー アクション。
列挙型 | |
---|---|
BLOCKING_REASON_UNSPECIFIED |
デフォルト値。 |
ALLOWLIST_STATIC_IP |
コネクタでは、静的 IP を許可リストに登録する必要があります。 |
ALLOWLIST_IN_SERVICE_ATTACHMENT |
コネクタを使用するには、お客様がサービス アタッチメントで Google のプロジェクトを許可リストに登録する必要があります。 |
ALLOWLIST_SERVICE_ACCOUNT |
コネクタでは、お客様のプロジェクトでサービス アカウントを許可リストに登録する必要があります。 |
IdentityScheduleConfig
ID データ同期の実行の構成。
JSON 表現 |
---|
{
"refreshInterval": string,
"nextSyncTime": {
object ( |
フィールド | |
---|---|
refreshInterval |
省略可。このコネクタによって取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔。設定しない場合、アクセス制御リストはデフォルトの 30 分間隔で更新されます。ID の更新間隔は、30 分から 7 日までの範囲で設定できます。
|
nextSyncTime |
省略可。データコネクタの次回のデータ同期が開始される予定の UTC 時間。お客様は、データ同期のスケジュールを設定する際に、時間と分のみを指定できます。これは、データコネクタの更新間隔が 1 日を超える場合に使用されます。 |
BAPConfig
BAP コネクタの構成。
JSON 表現 |
---|
{
"supportedConnectorModes": [
enum ( |
フィールド | |
---|---|
supportedConnectorModes[] |
必須。関連付けられた BAP 接続でサポートされているコネクタ モード。 |
enabledActions[] |
省略可。関連付けられた BAP 接続で有効になっているアクション。 |
ConnectorMode
この BAP コネクタでサポートされているユースケース。
列挙型 | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
コネクタモードが指定されていません。 |
DATA_INGESTION |
データ取り込みに使用されるコネクタ。 |
ACTIONS |
アクションに使用されるコネクタ |
END_USER_AUTHENTICATION |
エンドユーザー認証に使用されるコネクタ。 |
ConnectorType
コネクタのタイプ。
列挙型 | |
---|---|
CONNECTOR_TYPE_UNSPECIFIED |
デフォルト値。 |
THIRD_PARTY |
サードパーティ コネクタからサードパーティ アプリケーションへのコネクタ。 |
GCP_FHIR |
データ コネクタは、FHIR ストアと VAIS データストアを接続します。 |
BIG_QUERY |
BigQuery コネクタ。 |
GCS |
Google Cloud Storage コネクタ。 |
GOOGLE_MAIL |
Gmail コネクタ。 |
GOOGLE_CALENDAR |
Google カレンダー コネクタ。 |
GOOGLE_DRIVE |
Google ドライブ コネクタ。 |
NATIVE_CLOUD_IDENTITY |
People API を利用したユーザー検索用のネイティブ Cloud Identity コネクタ。 |
THIRD_PARTY_FEDERATED |
フェデレーション コネクタ。データを取り込まず、検索はサードパーティ アプリケーションの API によって行われるサードパーティ製コネクタです。 |
THIRD_PARTY_EUA |
エンドユーザー認証機能に使用されるコネクタ。 |
GCNV |
Google Cloud NetApp Volumes コネクタ。 |
AlertPolicyConfig
コネクタレベルのアラート構成。
JSON 表現 |
---|
{
"alertPolicyName": string,
"alertEnrollments": [
{
object ( |
フィールド | |
---|---|
alertPolicyName |
変更不可。AlertPolicy の完全修飾リソース名。 |
alertEnrollments[] |
省略可。各アラートの登録状態。 |
AlertEnrollment
アラートの登録ステータス。
JSON 表現 |
---|
{
"alertId": string,
"enrollState": enum ( |
フィールド | |
---|---|
alertId |
変更不可。アラートの ID。 |
enrollState |
必須。お客様の登録ステータス。 |
EnrollStates
アラートの登録ステータスの列挙型。
列挙型 | |
---|---|
ENROLL_STATES_UNSPECIFIED |
デフォルト値。アラート ポリシーに応答していないお客様に使用されます。 |
ENROLLED |
お客様はこのポリシーに登録されています。 |
DECLINED |
お客様がこのポリシーを拒否しました。 |
RealtimeSyncConfig
リアルタイム同期の追加パラメータを保存するリアルタイム同期の構成。
JSON 表現 |
---|
{
"webhookUri": string,
"realtimeSyncSecret": string,
"streamingError": {
object ( |
フィールド | |
---|---|
webhookUri |
省略可。コネクタの Webhook URL。リアルタイム同期の追加パラメータを指定します。 |
realtimeSyncSecret |
省略可。Webhook シークレットに使用される Secret Manager シークレットの ID。 |
streamingError |
省略可。ストリーミング エラーの詳細。 |
StreamingError
ストリーミング エラーの詳細。
JSON 表現 |
---|
{ "streamingErrorReason": enum ( |
フィールド | |
---|---|
streamingErrorReason |
省略可。ストリーミング エラー。 |
error |
省略可。エラーの詳細。 |
StreamingErrorReason
ストリーミング エラーの一般的なタイプ。
列挙型 | |
---|---|
STREAMING_ERROR_REASON_UNSPECIFIED |
ストリーミング エラーの理由が指定されていません。 |
STREAMING_SETUP_ERROR |
リアルタイム同期のリソースの設定中にエラーが発生しました。 |
STREAMING_SYNC_ERROR |
コネクタのリアルタイム同期の実行中にエラーが発生しました。 |
INGRESS_ENDPOINT_REQUIRED |
プライベート接続でリアルタイム同期を設定する場合は、上り(内向き)エンドポイントが必要です。 |