Method: projects.locations.collections.dataStores.patch

DataStore を更新します

HTTP リクエスト

PATCH https://discoveryengine.googleapis.com/v1alpha/{dataStore.name=projects/*/locations/*/collections/*/dataStores/*}

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

パスパラメータ

パラメータ
dataStore.name

string

変更不可。ID。データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}。

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

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

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

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

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.dataStores.update

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