REST Resource: projects.locations.indexEndpoints

资源：IndexEndpoint

表示 IndexEndpoint 资源的消息。ImageIndex 会部署到其中。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "description": string,
  "deployedIndex": {
    object (DeployedIndex)
  },
  "state": enum (State),
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string
}
字段
name

string

仅限输出。IndexEndpoint 的资源名称。格式：projects/{project}/locations/{location}/indexEndpoints/{indexEndpointId}
displayName

string

可选。IndexEndpoint 的显示名称。最多可包含 32 个字符。
description

string

可选。IndexEndpoint 的说明。长度不得超过 25,000 个字符。
deployedIndex

object (DeployedIndex)

仅限输出。在此 IndexEndpoint 中部署的索引。
state

enum (State)

仅限输出。IndexEndpoint 状态。
labels

map (key: string, value: string)

可选。应用于资源的标签必须符合以下要求：

  • 每项资源可以有多个标签，但不能超过 64 个。
  • 每个标签都必须采用键值对形式。
  • 键至少包含 1 个字符，最多包含 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。
  • 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符都必须使用 UTF-8 编码，且允许使用国际字符。
  • 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。
  • 键必须以小写字母或国际字符开头。

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

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
createTime

string (Timestamp format)

仅限输出。创建时间戳。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

仅限输出。更新时间戳。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

DeployedIndex

索引的部署。

JSON 表示法 
{
  "index": string
}
字段
index

string

必需。已部署的索引的名称。格式：projects/*/locations/*/corpora/*/indexes/*

州

IndexEndpoint 阶段。

枚举
STATE_UNSPECIFIED 默认值。不应使用。
CREATING 状态为“正在创建”。
CREATED 状态为“已创建”。
UPDATING 状态为“UPDATING”。
FAILED 状态为“失败”。

方法

create

 创建 IndexEndpoint。

delete

 删除 IndexEndpoint。

deployIndex

 将索引部署到 IndexEndpoint。

get

 获取 IndexEndpoint。

list

 列出项目中的所有 IndexEndpoint。

patch

 更新 IndexEndpoint。

searchIndexEndpoint

 搜索已部署的索引端点（仅限图片语料库类型）。

undeployIndex

 从 IndexEndpoint 取消部署索引。