Method: projects.locations.setUpDataConnector

Collection を作成し、その DataConnector を設定します。セットアップ後に DataConnector を停止するには、CollectionService.DeleteCollection メソッドを使用します。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*}:setUpDataConnector

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。Collection の親（projects/{project}/locations/{location} の形式）。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "collectionId": string,
  "collectionDisplayName": string,
  "dataConnector": {
    object (DataConnector)
  }
}
フィールド
collectionId

string

必須。Collection に使用する ID。Collection のリソース名の最終的なコンポーネントになります。DataConnector の設定の一部として、新しい Collection が作成されます。DataConnector は Collection のシングルトン リソースで、Collection のすべての DataStore を管理します。

このフィールドは RFC-1034 標準に準拠し、長さは 63 文字以下にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
collectionDisplayName

string

必須。Collection の表示名。

人が読める文字列で、コンソール ダッシュボードでコレクションを表示するために使用されます。UTF-8 でエンコードされた文字列で、上限は 1,024 文字です。
dataConnector

object (DataConnector)

必須。新しく作成された Collection で初期化する DataConnector。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.locations.setUpDataConnector

詳細については、IAM のドキュメントをご覧ください。