単一のインデックスのパラメータを更新します。
HTTP リクエスト
PATCH https://vectorsearch.googleapis.com/v1/{index.name}
パスパラメータ
| パラメータ | |
|---|---|
index.name |
識別子。リソースの名前 |
クエリ パラメータ
| パラメータ | |
|---|---|
updateMask |
省略可。更新によって Index リソース内で上書きされるフィールドを指定します。updateMask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。マスクを指定しない場合は、リクエストに含まれる空でない値のフィールドがすべて上書きされます。 次のフィールドは更新をサポートしています。*
完全修飾フィールド名のカンマ区切りリスト。例: |
requestId |
省略可。リクエストを識別するリクエスト ID（省略可）。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。 たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。 リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。 |
リクエストの本文
リクエストの本文には Index のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/cloud-platform
詳細については、Authentication Overview をご覧ください。
IAM 権限
name リソースに対する次の IAM 権限が必要です。
vectorsearch.indexes.update
詳細については、IAM のドキュメントをご覧ください。