Method: projects.locations.collections.updateDataConnector

DataConnector を更新します。

HTTP リクエスト

PATCH https://discoveryengine.googleapis.com/v1/{dataConnector.name=projects/*/locations/*/collections/*/dataConnector}

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

パスパラメータ

パラメータ
dataConnector.name

string

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

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

指定された DataConnector で更新するフィールドを示します。

サポートされているフィールド パスは次のとおりです。

  • refreshInterval
  • params
  • autoRunDisabled
  • actionConfig
  • actionConfig.action_params
  • actionConfig.service_name
  • destinationConfigs
  • blockingReasons
  • syncMode
  • incrementalSyncDisabled
  • incrementalRefreshInterval

注: これらのフィールドのサポートは、コネクタのタイプによって異なる場合があります。たとえば、すべてのコネクタが destinationConfigs をサポートしているわけではありません。

サポートされていないフィールド パスや不明なフィールド パスを指定すると、リクエストは INVALID_ARGUMENT エラーを返します。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には DataConnector のインスタンスが含まれます。

レスポンスの本文

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

認可スコープ

次の 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 権限

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

  • discoveryengine.dataConnectors.update

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