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)

省略可。リソースに適用するラベルは、次の要件を満たす必要があります。

  • 1 つのリソースには、最大 64 個のラベルを適用できます。
  • ラベルは、Key-Value ペアでなければなりません。
  • キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。
  • キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。
  • ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。
  • キーは、小文字または国際文字で始める必要があります。

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

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
createTime

string (Timestamp format)

出力専用。タイムスタンプを作成します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。更新タイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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 ステータスは UPDATING です。
FAILED 状態は FAILED です。

メソッド

create

 IndexEndpoint を作成します。

delete

 IndexEndpoint を削除します。

deployIndex

 インデックスを IndexEndpoint にデプロイします。

get

 IndexEndpoint を取得します。

list

 プロジェクト内のすべての IndexEndpoints を一覧表示します。

patch

 IndexEndpoint を更新します。

searchIndexEndpoint

 デプロイされたインデックス エンドポイントを検索します（IMAGE コーパス タイプのみ）。

undeployIndex

 IndexEndpoint からインデックスのデプロイを解除します。