Method: projects.locations.collections.engines.patch

更新 Engine

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
engine.name

string

不可变。标识符。引擎的完全限定资源名称。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine} 引擎应为 1-63 个字符，有效字符为 /[a-z0-9][a-z0-9-_]*/。否则，系统会返回 INVALID_ARGUMENT 错误。

查询参数

参数
updateMask

string (FieldMask format)

指示要更新所提供的 Engine 中的哪些字段。

如果提供不受支持或未知的字段，系统会返回 INVALID_STRING 错误。

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

请求正文

请求正文包含一个 Engine 实例。

响应正文

如果成功，则响应正文包含一个 Engine 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

  • discoveryengine.engines.update

如需了解详情，请参阅 IAM 文档。