Method: projects.locations.dataAgents.patch

更新单个 DataAgent 的参数。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
dataAgent.name

string

可选。标识符。DataAgent 的唯一资源名称。格式: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

建议在创建智能体期间跳过设置此字段,因为系统会自动推断此字段,并使用 {parent}/dataAgents/{dataAgentId} 覆盖此字段。

查询参数

参数
updateMask

string (FieldMask format)

可选。字段掩码用于指定更新要在 DataAgent 资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果用户未提供掩码,则请求中存在的所有具有非默认值的字段都会被覆盖。如果提供的是通配符掩码,则所有字段都会被覆盖。

这是完全限定字段名称的逗号分隔列表。示例:"user.displayName,photo"

requestId

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 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 文档