Method: projects.locations.dataStores.patch

単一の DataStore のパラメータを更新します。

dataStores.patch、dataStores.importDocuments、dataStores.purgeDocuments は、DataStore ごとに 1 つずつ実行されます。1 つのオペレーションが実行されている間、もう 1 つのオペレーションは待機できます。それ以上のリクエストは、実行中のオペレーションが完了するまで ABORTED で失敗します。

HTTP リクエスト

PATCH https://vectorsearch.googleapis.com/v1beta/{dataStore.name}

パスパラメータ

パラメータ
dataStore.name	string ID。DataStore の完全修飾リソース名。 形式: projects/{project}/locations/{location}/dataStores/{dataStoreId}

クエリ パラメータ

パラメータ
updateMask	string (FieldMask format) 省略可。フィールド マスクは、更新によって DataStore リソース内で上書きされるフィールドを指定するために使用されます。updateMask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。メッセージを指定するパスは、メッセージ全体を置き換えます。リクエストから省略されたサブフィールドはクリアされ、processingConfig でデフォルトに戻されます。 マスクを指定しない場合は、リクエストでデフォルト値以外に設定されているすべてのフィールドが上書きされます。空で送信されたメッセージ（layoutParsingConfig: {} など）とデフォルト値に設定されたフィールド（false など）は適用されません。代わりにマスクで名前を指定します。 更新がサポートされているフィールドは、displayName、description、labels、processingConfig、documentMetadataSchema です。documentMetadataSchema は全体として更新する必要があります（マスクパスは documentMetadataSchema）。また、広告プロパティを追加することによってのみ更新できます。既存のプロパティを削除または変更することはできません。 updateMask に * が指定されている場合、完全な置換が実行されます。 完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。
requestId	string 省略可。リクエストを識別するリクエスト ID（省略可）。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。 たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。 リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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