REST Resource: projects.locations.indexEndpoints

資源：IndexEndpoint

代表 IndexEndpoint 資源的訊息。並在其中部署 ImageIndexes。

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 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。更新時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："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 狀態為 CREATING。
CREATED 狀態為「CREATED」。
UPDATING 狀態為「更新中」。
FAILED 狀態為「FAILED」。

方法

create

 建立 IndexEndpoint。

delete

 刪除 IndexEndpoint。

deployIndex

 將索引部署至 IndexEndpoint。

get

 取得 IndexEndpoint。

list

 列出專案中的所有 IndexEndpoints。

patch

 更新 IndexEndpoint。

searchIndexEndpoint

 搜尋已部署的索引端點 (僅限圖片語料庫類型)。

undeployIndex

 從 IndexEndpoint 取消部署索引。