REST Resource: projects.locations.indexEndpoints

Ressource: IndexEndpoint

Message représentant la ressource IndexEndpoint. Les ImageIndexes y sont déployés.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "deployedIndex": {
    object (DeployedIndex)
  },
  "state": enum (State),
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'IndexEndpoint. Format : projects/{project}/locations/{location}/indexEndpoints/{indexEndpointId}

displayName

string

Facultatif. Nom à afficher du point de terminaison d'index. Il peut comporter jusqu'à 32 caractères.

description

string

Facultatif. Description de l'IndexEndpoint. Peut comporter jusqu'à 25 000 caractères.

deployedIndex

object (DeployedIndex)

Uniquement en sortie. L'index déployé dans ce point de terminaison d'index.

state

enum (State)

Uniquement en sortie. État de l'indexEndpoint.

labels

map (key: string, value: string)

Facultatif. Les libellés appliqués à une ressource doivent répondre aux exigences suivantes :

  • Chaque ressource peut avoir plusieurs étiquettes, jusqu'à un maximum de 64.
  • Chaque libellé doit correspondre à une paire clé/valeur.
  • Les clés doivent comporter un (1) caractère au minimum et 63 au maximum, et ne peuvent pas être vides. Les valeurs peuvent être vides et comporter 63 caractères au maximum.
  • Les clés et les valeurs ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. Tous les caractères doivent être au format d'encodage UTF-8. Les caractères internationaux sont autorisés.
  • La partie clé d'un libellé doit être unique. Cependant, vous pouvez utiliser la même clé avec plusieurs ressources.
  • Les clés doivent commencer par une lettre minuscule ou un caractère international.

Pour en savoir plus, consultez le document Google Cloud.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Uniquement en sortie. Créez un code temporel.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de mise à jour.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

DeployedIndex

Déploiement d'un index.

Représentation JSON
{
  "index": string
}
Champs
index

string

Obligatoire. Nom de l'index déployé. Format : projects/*/locations/*/corpora/*/indexes/*

État

Étape IndexEndpoint.

Enums
STATE_UNSPECIFIED Valeur par défaut. Ne doit pas être utilisé.
CREATING État CREATING.
CREATED État CREATED.
UPDATING État UPDATING.
FAILED État ÉCHEC.

Méthodes

create

Crée un IndexEndpoint.

delete

Supprime un point de terminaison d'index.

deployIndex

Déploie un index sur un point de terminaison d'index.

get

Récupère un point de terminaison d'index.

list

Répertorie tous les points de terminaison d'index d'un projet.

patch

Met à jour un point de terminaison d'index.

searchIndexEndpoint

Recherchez un point de terminaison d'index déployé (type de corpus IMAGE uniquement).

undeployIndex

Annule le déploiement d'un index à partir d'un point de terminaison d'index.