REST Resource: projects.locations.indexEndpoints

Ressource: IndexEndpoint

Nachricht, die die IndexEndpoint-Ressource darstellt. ImageIndexes werden dort bereitgestellt.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "description": string,
  "deployedIndex": {
    object (DeployedIndex)
  },
  "state": enum (State),
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string
}
Felder
name

string

Nur Ausgabe. Ressourcenname des Index-Endpunkts. Format: projects/{project}/locations/{location}/indexEndpoints/{indexEndpointId}

displayName

string

Optional. Anzeigename des Indexendpunkts. Er kann bis zu 32 Zeichen lang sein.

description

string

Optional. Beschreibung des Index-Endpunkts. Kann bis zu 25.000 Zeichen lang sein.

deployedIndex

object (DeployedIndex)

Nur Ausgabe. Der in diesem IndexEndpoint bereitgestellte Index.

state

enum (State)

Nur Ausgabe. Status des Indexendpunkts.

labels

map (key: string, value: string)

Optional. Die Labels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen:

  • Jede Ressource kann bis zu 64 Labels haben.
  • Jedes Label muss ein Schlüssel/Wert-Paar sein.
  • Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen.
  • Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig.
  • Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden.
  • Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen.

Weitere Informationen finden Sie im Google Cloud-Dokument.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Nur Ausgabe. Erstellen Sie einen Zeitstempel.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Nur Ausgabe. Aktualisieren Sie den Zeitstempel.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

DeployedIndex

Eine Bereitstellung eines Index.

JSON-Darstellung
{
  "index": string
}
Felder
index

string

Pflichtangabe. Name des bereitgestellten Index. Format: projects/*/locations/*/corpora/*/indexes/*

Bundesland

IndexEndpoint-Phase.

Enums
STATE_UNSPECIFIED Der Standardwert. Sollte nicht verwendet werden.
CREATING Status: CREATING
CREATED Status: CREATED.
UPDATING Status: AKTUALISIERT.
FAILED Status: FEHLER.

Methoden

create

Erstellt einen IndexEndpoint.

delete

Löscht einen IndexEndpoint.

deployIndex

Stellt einen Index für den IndexEndpoint bereit.

get

Ruft einen IndexEndpoint ab.

list

Listet alle Indexendpunkte in einem Projekt auf.

patch

Aktualisiert einen IndexEndpoint.

searchIndexEndpoint

In einem bereitgestellten Indexendpunkt suchen (nur Bildkorpustyp)

undeployIndex

Heben Sie die Bereitstellung eines Index aus dem IndexEndpoint auf.