Method: projects.locations.dataAgents.patch

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

HTTP リクエスト

PATCH https://geminidataanalytics.googleapis.com/v1alpha/{dataAgent.name=projects/*/locations/*/dataAgents/*}

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

パスパラメータ

パラメータ
dataAgent.name

string

省略可。ID。Agent の一意のリソース名。形式: projects/{project}/locations/{location}/dataAgents/{dataAgentId}。{dataAgent} はリソース ID で、63 文字以下である必要があります。また、https://google.aip.dev/122#resource-id-segments で説明されている形式と一致する必要があります。

例: projects/1234567890/locations/us-central1/dataAgents/my-agent。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

省略可。フィールド マスクは、更新によって DataAgent リソース内で上書きされるフィールドを指定するために使用されます。updateMask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。マスクを指定しない場合は、リクエストに含まれるデフォルト値でないフィールドがすべて上書きされます。ワイルドカード マスクを指定すると、すべてのフィールドが上書きされます。

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

string

省略可。リクエストを識別するリクエスト ID（省略可）。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

次の OAuth スコープが必要です。

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

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

IAM 権限

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

  • geminidataanalytics.dataAgents.update

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