REST Resource: projects.locations.collections

リソース: Collection

Collection は、リソースと一連の DataStore へのアクセスを構成するためのコンテナです。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "dataConnector": {
    object (DataConnector)
  },
  "createTime": string
}
フィールド
name

string

変更不可。Collection の完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collectionId}。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
displayName

string

必須。Collection の表示名。

このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
dataConnector

object (DataConnector)

出力専用。データコネクタが存在する場合、Collection 内のデータストアの接続を管理します。コネクタを設定するには、DataConnectorService.SetUpDataConnector メソッドを使用します。このメソッドは、DataConnector シングルトン リソースを設定しながら、新しい Collection を作成します。既存の Collection でコネクタを設定することはできません。

この出力専用フィールドには、name、dataSource、entities.entity_name、entities.data_store などの DataConnector フィールドのサブセットが含まれます。

データコネクタの詳細を取得するには、DataConnectorService.GetDataConnector メソッドを使用します。
createTime

string (Timestamp format)

出力専用。Collection の作成時のタイムスタンプ。

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

DataConnector

Collection にグループ化されたすべてのデータストアの外部データソースへの接続を管理します。これは Collection のシングルトン リソースです。初期化は DataConnectorService.SetUpDataConnector メソッドでのみサポートされます。このメソッドは新しい Collection を作成し、その DataConnector を初期化します。

JSON 表現 
{
  "name": string,
  "state": enum (State),
  "dataSource": string,
  "removeParamKeys": [
    string
  ],
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  },
  "entities": [
    {
      object (SourceEntity)
    }
  ],
  "createTime": string,
  "latestPauseTime": string,
  "lastSyncTime": string,
  "updateTime": string,
  "errors": [
    {
      object (Status)
    }
  ],
  "syncMode": enum (SyncMode),
  "kmsKeyName": string,
  "destinationConfigs": [
    {
      object (DestinationConfig)
    }
  ],
  "actionState": enum (State),
  "actionConfig": {
    object (ActionConfig)
  },
  "endUserConfig": {
    object (EndUserConfig)
  },
  "federatedConfig": {
    object (FederatedConfig)
  },
  "connectorModes": [
    enum (ConnectorMode)
  ],
  "staticIpEnabled": boolean,
  "staticIpAddresses": [
    string
  ],
  "oauthStaticIpAddresses": [
    string
  ],
  "blockingReasons": [
    enum (BlockingReason)
  ],
  "identityRefreshInterval": string,
  "identityScheduleConfig": {
    object (IdentityScheduleConfig)
  },
  "privateConnectivityProjectId": string,
  "bapConfig": {
    object (BAPConfig)
  },
  "connectorType": enum (ConnectorType),
  "realtimeState": enum (State),
  "alertPolicyConfigs": [
    {
      object (AlertPolicyConfig)
    }
  ],
  "realtimeSyncConfig": {
    object (RealtimeSyncConfig)
  },
  "aclEnabled": boolean,
  "createEuaSaas": boolean,
  "autoRunDisabled": boolean,
  "incrementalSyncDisabled": boolean,
  "incrementalRefreshInterval": string,
  "hybridIngestionDisabled": boolean,
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  },
  "egressFqdns": [
    string
  ],
  "vpcscEnabled": boolean,
  "dynamicTools": [
    {
      object (DynamicTool)
    }
  ],
  "cliConfig": {
    object (CliConfig)
  },
  "connectorSourceId": string,
  "tag": string,
  "metadata": {
    object (ConnectorMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
フィールド
name

string

ID。データコネクタの完全なリソース名。形式: projects/*/locations/*/collections/*/dataConnector。
state

enum (State)

出力専用。コネクタの状態。
dataSource

string

必須。データソースの識別子。サポートされているコネクタとその値の最新の完全なリストについては、サードパーティ データソースを接続するをご覧ください。
removeParamKeys[]

string

省略可。「params」フィールドから削除するキーを指定します。これは、UpdateDataConnectorRequest の updateMask に params が含まれている場合にのみ有効になります。キーが removeParamKeys とリクエストの params フィールドの両方に存在する場合、削除が優先されます。
refreshInterval

string (Duration format)

必須。データ同期の更新間隔。期間を 0 に設定すると、データはリアルタイムで同期されます。ストリーミング機能はまだサポートされていません。最小値は 30 分、最大値は 7 日です。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります。

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

object (DateTime)

次回データ同期を行うスケジュール時刻を定義します。このフィールドには、IANA タイムゾーン データベースの時、分、タイムゾーンが必要です。これは、データコネクタの更新間隔が 1 日を超える場合に使用します。時または分が指定されていない場合、同期時刻は 0:00 とみなされます。ユーザーは、あいまいさを避けるためにタイムゾーンを指定する必要があります。
entities[]

object (SourceEntity)

接続されたデータソースから取り込むエンティティのリスト。
createTime

string (Timestamp format)

出力専用。DataConnector の作成時のタイムスタンプ。

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

string (Timestamp format)

出力専用。この DataConnector が一時停止された最新のタイムスタンプ。データ同期など、すべての機能に影響します。コネクタを一時停止すると、次の影響があります。

  • データ同期を含むすべての機能が停止します。
  • 進行中のデータ同期ジョブはすべてキャンセルされます。
  • 今後のデータ同期の実行はスケジュールされず、トリガーすることもできません。

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

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)

出力専用。DataConnector が最後に更新されたときのタイムスタンプ。

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"。
errors[]

object (Status)

出力専用。初期化または最新のコネクタ実行によって発生したエラー。
syncMode

enum (SyncMode)

データコネクタでサポートされているデータ同期モード。
kmsKeyName

string

入力専用。このコネクタで管理される DataStore の保護に使用される KMS 鍵。

CMEK 組織のポリシーの保護に準拠する必要があるリクエストに対して設定する必要があります。

このフィールドが設定され、正常に処理されると、このコネクタによって作成された DataStore は KMS 鍵によって保護されるようになります。
destinationConfigs[]

object (DestinationConfig)

省略可。サードパーティのサービスへの接続に使用されるターゲットの宛先。
actionState

enum (State)

出力専用。アクション コネクタの状態。アクション コネクタが初期化中なのか、アクティブなのか、あるいはエラーが発生したのかどうかが反映されます。
actionConfig

object (ActionConfig)

省略可。コネクタによってアクションをサポートするアクション構成。
endUserConfig

object (EndUserConfig)

省略可。EUA コネクタ専用に使用されるパラメータと認証情報。
federatedConfig

object (FederatedConfig)

省略可。FEDERATED モードをサポートするハイブリッド コネクタ専用に使用されるパラメータと認証情報。このフィールドは、コネクタがハイブリッド コネクタで、FEDERATED モードを有効にする場合にのみ設定する必要があります。
connectorModes[]

enum (ConnectorMode)

省略可。このコネクタで有効になっているモード: デフォルトの状態は CONNECTOR_MODE_UNSPECIFIED です。
staticIpEnabled

boolean

省略可。ユーザーがこのコネクタで静的 IP アドレスを有効にしているかどうか。
staticIpAddresses[]

string

出力専用。このコネクタで使用される静的 IP アドレス。
oauthStaticIpAddresses[]

string

出力専用。このコネクタが OAuth API（エンドユーザー認証など）に使用する静的 IP アドレス。これらは staticIpAddresses とは別に表示されるため、OAuth エンドポイントにきめ細かいファイアウォール設定を適用できます。静的 IP が有効になっていて、アクションや連携検索に使用されているコネクタに対してのみ入力されます。
blockingReasons[]

enum (BlockingReason)

出力専用。コネクタによるデータの同期を開始するために完了しておく必要があるユーザー アクション。
identityRefreshInterval
(deprecated)

string (Duration format)

このコネクタによって取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔。設定しない場合、アクセス制御リストはデフォルトの 30 分間隔で更新されます。ID の更新間隔は、30 分から 7 日までの範囲で設定できます。

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

object (IdentityScheduleConfig)

ID データ同期の実行の構成。このコネクタで取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔が含まれます。
privateConnectivityProjectId

string

出力専用。プライベート接続コネクタに関連付けられているテナント プロジェクト ID。コネクタが機能するには、このプロジェクトを許可リストに登録する必要があります。
bapConfig

object (BAPConfig)

省略可。BAP 接続を確立するための構成。
connectorType

enum (ConnectorType)

出力専用。コネクタのタイプ。各ソースは 1 つのタイプにのみマッピングできます。たとえば、salesforce、confluence、jira のコネクタタイプは THIRD_PARTY です。システムによって設定されると、変更できません。
realtimeState

enum (State)

出力専用。リアルタイム同期の状態
alertPolicyConfigs[]

object (AlertPolicyConfig)

省略可。コネクタレベルのアラート構成。
realtimeSyncConfig

object (RealtimeSyncConfig)

省略可。リアルタイム同期の構成。
aclEnabled

boolean

省略可。コネクタが ACL 構成で作成されるかどうか。現在このフィールドは、Cloud Storage コネクタと BigQuery コネクタにのみ影響します。
createEuaSaas

boolean

省略可。END USER AUTHENTICATION コネクタが SaaS で作成されているかどうか。
autoRunDisabled

boolean

省略可。コネクタが自動実行で無効になっているかどうかを示します。定期的な同期とリアルタイム同期を一時停止するために使用できます。更新情報: incrementalSyncDisabled の導入により、autoRunDisabled は完全同期の一時停止 / 無効化にのみ使用されるようになりました
incrementalSyncDisabled

boolean

省略可。このコネクタの増分同期が一時停止されているかどうかを示します。これは autoRunDisabled とは独立しています。サードパーティ コネクタにのみ適用されます。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります（true に設定されます）。
incrementalRefreshInterval

string (Duration format)

省略可。増分データ同期専用の更新間隔。設定されていない場合、増分同期では環境のデフォルト（3 時間）が使用されます。最小値は 30 分、最大値は 7 日です。サードパーティ コネクタにのみ適用されます。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります。

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

boolean

省略可。コネクタがハイブリッド コネクタの場合、コネクタの作成時に取り込みが有効になり、適切なリソースがプロビジョニングされるかどうかを決定します。コネクタがハイブリッド コネクタでない場合、このフィールドは無視されます。
dataProtectionPolicy

object (DataProtectionPolicy)

省略可。コネクタのデータ保護ポリシーを指定します。
egressFqdns[]

string

出力専用。データコネクタが送信できる FQDN のリスト。これには、お客様が提供したインスタンス URL から派生した FQDN と、コネクタ タイプごとのデフォルトの FQDN の両方が含まれます。
vpcscEnabled

boolean

出力専用。コネクタが VPC-SC を有効にして作成されるかどうか。
dynamicTools[]

object (DynamicTool)

出力専用。このコネクタ用に取得された動的ツール。
cliConfig

object (CliConfig)

省略可。CLI 接続を確立するための構成。
connectorSourceId

string

省略可。設定されている場合、dataSource の代わりにこの値を使用して、対応するコネクタソースが取得されます。
tag

string

省略可。変更不可。このコネクタのユーザー向けバージョン非依存ラベル。同じ（プロジェクト、ロケーション、コレクション、dataSource）の下にある複数のコネクタで共有できます。タグベースのルックアップでは、createTime が最も大きいものが返されます。

作成時に省略可。Agent Designer は、設定されている場合は（dataSource、tag）を介してコネクタを解決し、設定されていない場合は以前のリソース名ルックアップにフォールバックします。そのため、タグ書き込みのリリース前に作成されたコネクタは、バックフィルなしで引き続き機能します。
metadata

object (ConnectorMetadata)

省略可。コネクタのユーザー向けメタデータ。コネクタの生成されたメタデータ / レジストリ ConnectorSource から入力されます。

ソースにアクセスするために必要なパラメータ（Key-Value ペアの形式）。projects/*/[locations/*/]secrets/*/versions/* 形式の文字列値は Secret Manager から読み取られます。

すべてのデータソースで必須のパラメータ:

  • キー: instance_uri
  • 値: STRING 型。データソースにアクセスするための URI。

OAUTH をサポートするソース（salesforce など）の必須パラメータ:

  • キー: client_id
  • 値: STRING 型。アプリケーションを識別するためのサードパーティ サービス プロバイダのクライアント ID。
  • キー: client_secret
  • 値: STRING 型。サードパーティ認証サーバーによって生成されたクライアント シークレット。
  • キー: access_token
  • 値: STRING 型。保護リソースにアクセスするための UCS の OAuth トークン。
  • キー: refresh_token
  • 値: STRING 型。UCS が、ユーザーの操作なしで新しいアクセス トークンを取得するための OAuth 更新トークン。

基本的な API トークン認証（jira、confluence など）をサポートするソースに必要なパラメータ:

  • キー: user_account
  • 値: STRING 型。ソースを含むユーザー名またはメールアドレス。
  • キー: api_token
  • 値: STRING 型。ソース アカウント用に生成された API トークン。パスワードを使用する場所での認証に使用されます。

例:

{
                                  "instance_uri": "https://xxx.atlassian.net",
                                  "user_account": "xxxx.xxx@xxx.com",
                                  "api_token": "test-token"
                                }

複数の認証タイプをサポートできるように、使用する認証タイプを指定するパラメータ（省略可能）:

  • キー: auth_type
  • 値: STRING 型。データソースの認証タイプ。サポートされている値は、BASIC_AUTH、OAUTH、OAUTH_ACCESS_TOKEN、OAUTH_TWO_LEGGED、OAUTH_JWT_BEARER、OAUTH_PASSWORD_GRANT、JWT、API_TOKEN、FEDERATED_CREDENTIAL、NO_AUTH です。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
params

object (Struct format)

構造化された JSON 形式の必須データコネクタ パラメータ。
jsonParams

string

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 (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
フィールド
entityName

string

エンティティの名前。各データソースでサポートされている値:

  • Salesforce: Lead、Opportunity、Contact、Account、Case、Contract、Campaign
  • Jira Issue
  • Confluence: Content、Space
keyPropertyMappings

map (key: string, value: string)

インデックス登録用の属性。キー: フィールド名。値: フィールドをマッピングするキープロパティ（title、description など）。サポートされているキープロパティ:

  • title: データレコードのタイトル。これは検索結果に表示されます。
  • description: データレコードの説明。これは検索結果に表示されます。
dataStore

string

出力専用。ソース エンティティに関連付けられたデータストアの完全なリソース名。形式: projects/*/locations/*/collections/*/dataStores/*。コネクタが DataConnectorService.SetUpDataConnector メソッドによって初期化されると、各ソース エンティティに対して DataStore が自動的に作成されます。
startingSchema

object (Schema)

省略可。この SourceEntity から作成された DataStore に使用する開始スキーマ。設定されていない場合、デフォルトの業種専門スキーマが使用されます。

このフィールドは SetUpDataConnector API でのみ使用され、他の API で使用された場合は無視されます。このフィールドは、collections.getDataConnector API を含むすべての API レスポンスから省略されます。DataStore のスキーマを取得するには、代わりに SchemaService.GetSchema API を使用します。

提供されたスキーマは、スキーマに関する特定のルールに照らして検証されます。詳しくは、こちらのドキュメントをご覧ください。
healthcareFhirConfig

object (HealthcareFhirConfig)

省略可。HEALTHCARE_FHIR カテゴリの構成。

データの取り込みを容易にするエンティティのパラメータ。たとえば、BigQuery コネクタの場合は、以下のようになります。

  • キー: document_id_column
  • 値: STRING 型。列 ID の値。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
params

object (Struct format)

構造化された JSON 形式でのデータの取り込みを容易にするエンティティのパラメータ。
jsonParams

string

JSON 文字列形式で、データの取り込みを容易にするエンティティのパラメータ。
相互に排他的なフィールドの終了。

SyncMode

データコネクタでサポートされているデータ同期モードを定義します。

列挙型
PERIODIC コネクタは、refreshInterval に基づいてデータを定期的に同期します。autoRunDisabled と組み合わせて使用して、定期的な同期の一時停止や、1 回限りの同期の指定を行います。
STREAMING データはリアルタイムで同期されます。
UNSPECIFIED データを取り込まないコネクタには、この値が設定されます

DestinationConfig

サードパーティ ソースへの接続に使用されるターゲット エンドポイントを定義します。

JSON 表現 
{
  "key": string,
  "destinations": [
    {
      object (Destination)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
フィールド
key

string

省略可。コネクタでサポートされている一意の宛先識別子。
destinations[]

object (Destination)

省略可。対応するキーの宛先。
この宛先構成の追加パラメータ。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
params

object (Struct format)

省略可。この宛先構成の追加パラメータ（構造化された JSON 形式）。
jsonParams

string

この宛先構成の追加パラメータ（JSON 文字列形式）。
相互に排他的なフィールドの終了。

宛先

ターゲット エンドポイントを定義します

JSON 表現 
{
  "port": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "host": string
  // End of mutually exclusive fields.
}
フィールド
port

integer

省略可。宛先で受け入れられたターゲット ポート番号。
エンドポイントの宛先。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
host

string

一般公開されたルーティング可能なホスト。
相互に排他的なフィールドの終了。

ActionConfig

コネクタのアクションをサポートする情報。

JSON 表現 
{
  "isActionConfigured": boolean,
  "serviceName": string,
  "useStaticSecrets": boolean,
  "createBapConnection": boolean,
  "userDefinedScopesMapping": {
    string: {
      object (ScopeList)
    },
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionParams": {
    object
  },
  "jsonActionParams": string
  // End of mutually exclusive fields.
}
フィールド
isActionConfigured

boolean

出力専用。コネクタには必要なパラメータが含まれており、アクションをサポートするように構成されています。
serviceName

string

省略可。DataConnector.params で定義された、VPC ネットワーク エンドポイントを表す Service Directory リソース名（projects/*/locations/*/namespaces/*/services/*）。データソースの instanceUri への接続に使用されます。

VPC Service Controls が有効な場合は必須です。
useStaticSecrets

boolean

省略可。コネクタに静的シークレットを使用するかどうか。true の場合、actionParams で指定されたシークレットは無視されます。
createBapConnection

boolean

省略可。コネクタの BAP 接続を作成するかどうか。
userDefinedScopesMapping

map (key: string, value: object (ScopeList))

省略可。オペレーション名からスコープのリストへのマッピング。ユーザー指定のスコープがある場合にのみ入力されます。

アクションをサポートするために必要なパラメータ（Key-Value ペアの形式）。projects/*/[locations/*/]secrets/*/versions/* 形式の文字列値は Secret Manager から読み取られます。

OAUTH をサポートするソース（gmail、google_calendar、jira、workday、salesforce、confluence）の必須パラメータ:

  • キー: client_id
  • 値: STRING 型。アプリケーションを識別するためのサービス プロバイダのクライアント ID。
  • キー: client_secret
  • 値: STRING 型。アプリケーションの認証サーバーによって生成されたクライアント シークレット。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
actionParams

object (Struct format)

省略可。構造化された JSON 形式のアクション パラメータ。
jsonActionParams

string

省略可。JSON 文字列形式のアクション パラメータ。
相互に排他的なフィールドの終了。

ScopeList

スコープのリストを保存します。

JSON 表現 
{
  "scopes": [
    string
  ]
}
フィールド
scopes[]

string

省略可。スコープのリスト。

EndUserConfig

EUA コネクタ専用に使用されるパラメータと認証情報。

JSON 表現 
{
  "additionalParams": {
    object
  },
  "tenant": {
    object (Tenant)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
フィールド
additionalParams

object (Struct format)

省略可。EUA に必要な追加のパラメータ。
tenant

object (Tenant)

省略可。コネクタが接続されているテナント プロジェクト。
EUA コネクタの認証構成。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
authParams

object (Struct format)

省略可。EUA コネクタに固有の認証パラメータ。
jsonAuthParams

string

省略可。EUA コネクタに固有の認証パラメータ（JSON 文字列形式）。
相互に排他的なフィールドの終了。

テナント

コネクタソースのテナント情報。これには、Credential メッセージに保存されている情報の一部が含まれますが、アクセス可能なテナントのリストをユーザーに提供するために必要な情報のみに限定されます。

JSON 表現 
{
  "id": string,
  "uri": string,
  "displayName": string
}
フィールド
id

string

テナントのインスタンス ID。例: Jira（「8594f221-9797-5f78-1fa4-485e198d7cd0」）、Slack（「T123456」）。
uri

string

テナントの URI（該当する場合）。たとえば、Jira インスタンスの URI は https://my-jira-instance.atlassian.net です。Slack テナントには URI がありません。
displayName

string

テナントのオプションの表示名（「My Slack Team」など）。

FederatedConfig

FEDERATED モードをサポートするハイブリッド コネクタ専用に使用されるパラメータと認証情報。

JSON 表現 
{
  "additionalParams": {
    object
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
フィールド
additionalParams

object (Struct format)

省略可。FEDERATED に必要な追加のパラメータ。
FEDERATED コネクタの認証構成。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
authParams

object (Struct format)

省略可。FEDERATED コネクタに固有の認証パラメータ。
jsonAuthParams

string

省略可。FEDERATED コネクタに固有の認証パラメータ（JSON 文字列形式）。
相互に排他的なフィールドの終了。

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 (DateTime)
  }
}
フィールド
refreshInterval

string (Duration format)

省略可。このコネクタによって取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔。設定しない場合、アクセス制御リストはデフォルトの 30 分間隔で更新されます。ID の更新間隔は、30 分から 7 日までの範囲で設定できます。

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

object (DateTime)

省略可。データコネクタの次回のデータ同期が開始される予定の UTC 時間。データ同期のスケジュールを設定する際に指定できるのは、時間と分のみです。これは、データコネクタの更新間隔が 1 日を超える場合に使用します。

BAPConfig

BAP コネクタの構成。

JSON 表現 
{
  "supportedConnectorModes": [
    enum (ConnectorMode)
  ],
  "enabledActions": [
    string
  ],
  "toolspecOverride": {
    object (ToolspecOverride)
  }
}
フィールド
supportedConnectorModes[]

enum (ConnectorMode)

必須。関連付けられた BAP 接続でサポートされているコネクタモード。
enabledActions[]

string

省略可。関連付けられた BAP 接続で有効になっているアクション。
toolspecOverride

object (ToolspecOverride)

省略可。この接続のカスタム toolspec オーバーライド。管理者によるツール定義をサポートする Enterprise BAP コネクタの場合、これはツールごとの（簡略化された）オーバーライドを保持します。Get で、永続化されたオーバーライドとライブ ランタイム ツール定義をマージし、UI で使用できるように結果をトリミングして、サーバーによって入力されます。更新時、指定された値は、サーバーサイドの検証とマージの後、永続化されたオーバーライドを置き換えます。baseVersion フィールドは、サーバーの現在のベース ツールスペック バージョンと一致しなければなりません（一致しない場合、管理者に最新のツールを再ダウンロードするよう指示するユーザー向けのエラーでリクエストが拒否されます）。

ConnectorMode

この BAP コネクタでサポートされているユースケース。

列挙型
CONNECTOR_MODE_UNSPECIFIED コネクタモードが指定されていない。
DATA_INGESTION データの取り込みに使用されるコネクタ。
ACTIONS アクションに使用されるコネクタ
END_USER_AUTHENTICATION エンドユーザー認証に使用されるコネクタ。

ToolspecOverride

BAP 接続の管理者キュレーションの toolspec の顧客向けビュー。Discovery Engine UI で管理者に表示され、編集可能なツールごとの（簡略化された）定義を保持します。

バックエンドの google.cloud.connectorexecution.v1.ToolspecOverride メッセージの形状を反映していますが、Discovery Engine API サーフェスが fed-API サーフェス（AIP-215）とは独立して進化できるように、意図的に別の公開タイプとして保持されています。ハンドラは、//cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util のヘルパーを介して 2 つの間で変換します。

JSON 表現 
{
  "tools": [
    {
      object
    }
  ],
  "baseVersion": string
}
フィールド
tools[]

object (Struct format)

必須。管理者が fed API から返されたベースの toolspec の上にカスタマイズしたツール定義（ツールごとに 1 つの Struct）。必須。変更 API でユーザーが編集できる唯一のフィールドであるため。リクエストには少なくとも 1 つのツールが含まれている必要があります。
baseVersion

string

必須。tools が作成された基準となる toolspec のバージョン。更新時に、接続のサーバーの現在の安定版の toolspec バージョンと一致しなければなりません。一致しない場合は、管理者に最新のツールを再ダウンロードするよう指示するユーザー向けのエラーで拒否されます。

ConnectorType

コネクタのタイプ。今後、この列挙型に新しい値が追加される可能性があります。

列挙型
CONNECTOR_TYPE_UNSPECIFIED デフォルト値。
THIRD_PARTY サードパーティ アプリケーションに接続するサードパーティ コネクタ。
GCP_FHIR データコネクタは、FHIR ストアと VAIS データストアを接続します。
BIG_QUERY Big Query コネクタ。
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 コネクタ。
GOOGLE_CHAT Google Chat コネクタ。
GOOGLE_SITES Google サイト コネクタ。
REMOTE_MCP リモート MCP ベースのコネクタ。
GOOGLE_WORKSPACE Google Workspace コネクタ。

AlertPolicyConfig

コネクタレベルのアラート構成。

JSON 表現 
{
  "alertPolicyName": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ]
}
フィールド
alertPolicyName

string

変更不可。AlertPolicy の完全修飾リソース名。
alertEnrollments[]

object (AlertEnrollment)

省略可。各アラートの登録状態。

AlertEnrollment

アラートの登録ステータス。

JSON 表現 
{
  "alertId": string,
  "enrollState": enum (EnrollStates)
}
フィールド
alertId

string

変更不可。アラートの ID。
enrollState

enum (EnrollStates)

必須。ユーザーの登録ステータス。

EnrollStates

アラートの登録ステータスの列挙型。

列挙型
ENROLL_STATES_UNSPECIFIED デフォルト値。アラート ポリシーに応答していないユーザーに使用されます。
ENROLLED ユーザーはこのポリシーに登録されています。
DECLINED ユーザーがこのポリシーを拒否しました。

RealtimeSyncConfig

リアルタイム同期の追加パラメータを保存するリアルタイム同期の構成。

JSON 表現 
{
  "webhookUri": string,
  "realtimeSyncSecret": string,
  "streamingError": {
    object (StreamingError)
  }
}
フィールド
webhookUri

string

省略可。コネクタの Webhook URL。リアルタイム同期の追加パラメータを指定します。
realtimeSyncSecret

string

省略可。Webhook シークレットに使用される Secret Manager シークレットの ID。
streamingError

object (StreamingError)

省略可。ストリーミング エラーの詳細。

StreamingError

ストリーミング エラーの詳細。

JSON 表現 
{
  "streamingErrorReason": enum (StreamingErrorReason),
  "error": {
    object (Status)
  }
}
フィールド
streamingErrorReason

enum (StreamingErrorReason)

省略可。ストリーミング エラー
error

object (Status)

省略可。エラーの詳細。

StreamingErrorReason

ストリーミング エラーの一般的なタイプ。

列挙型
STREAMING_ERROR_REASON_UNSPECIFIED ストリーミング エラーの理由が指定されていません。
STREAMING_SETUP_ERROR リアルタイム同期のリソースの設定中にエラーが発生しました。
STREAMING_SYNC_ERROR コネクタのリアルタイム同期の実行中にエラーが発生しました。
INGRESS_ENDPOINT_REQUIRED プライベート接続でリアルタイム同期を設定する場合は、上り（内向き）エンドポイントが必要です。

DynamicTool

動的ツールの構成。

JSON 表現 
{
  "name": string,
  "description": string,
  "enabled": boolean,
  "displayName": string
}
フィールド
name

string

必須。ツールの名前。
description

string

省略可。ツールの説明。
enabled

boolean

省略可。ツールが有効かどうか。
displayName

string

省略可。ツールの表示名。

CliConfig

CLI 実行ベースのコネクタの構成。

JSON 表現 
{
  "enabledActions": [
    string
  ]
}
フィールド
enabledActions[]

string

省略可。関連付けられた CLI 接続で有効になっているアクション。

メソッド

delete

 Collection を削除します。

get

 Collection を取得します。

getDataConnector

 DataConnector を取得します。

getIamPolicy

 Collection の IAM アクセス制御ポリシーを取得します。

list

 Collection のリストを取得します。

patch

 Collection を更新します。

setIamPolicy

 Collection の IAM アクセス制御ポリシーを設定します。

updateDataConnector

 DataConnector を更新します。