REST Resource: projects.locations.indexEndpoints

Recurso: IndexEndpoint

Es un mensaje que representa el recurso IndexEndpoint. Los ImageIndexes se implementan en él.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "deployedIndex": {
    object (DeployedIndex)
  },
  "state": enum (State),
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string
}
Campos
name

string

Solo salida. Es el nombre del recurso de IndexEndpoint. Formato: projects/{project}/locations/{location}/indexEndpoints/{indexEndpointId}
displayName

string

Opcional. Es el nombre visible del IndexEndpoint. Puede tener hasta 32 caracteres.
description

string

Opcional. Es la descripción de IndexEndpoint. Puede tener hasta 25,000 caracteres.
deployedIndex

object (DeployedIndex)

Solo salida. El índice implementado en este IndexEndpoint.
state

enum (State)

Solo salida. Estado de IndexEndpoint.
labels

map (key: string, value: string)

Opcional. Las etiquetas que se aplican a un recurso deben cumplir los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta 64.
  • Cada etiqueta debe ser un par clave-valor.
  • Las claves deben tener una longitud mínima de 1 carácter y una máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres.
  • Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales.
  • La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos.
  • Las claves deben comenzar con una letra en minúscula o un carácter internacional.

Consulta el Documento de Google Cloud para obtener más detalles.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo salida. Crea una marca de tiempo.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo salida. Marca de tiempo de actualización.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

DeployedIndex

Es una implementación de un índice.

Representación JSON 
{
  "index": string
}
Campos
index

string

Obligatorio. Es el nombre del índice implementado. Formato: projects/*/locations/*/corpora/*/indexes/*

Estado

Etapa de IndexEndpoint.

Enums
STATE_UNSPECIFIED Es el valor predeterminado. No se debe usar.
CREATING Estado CREATING.
CREATED Estado CREATED.
UPDATING Estado UPDATING.
FAILED Estado FAILED.

Métodos

create

 Crea un IndexEndpoint.

delete

 Borra un IndexEndpoint.

deployIndex

 Implementa un índice en IndexEndpoint.

get

 Obtiene un IndexEndpoint.

list

 Enumera todos los IndexEndpoints de un proyecto.

patch

 Actualiza un IndexEndpoint.

searchIndexEndpoint

 Busca un extremo de índice implementado (solo para el tipo de corpus de IMÁGENES).

undeployIndex

 Anula la implementación de un índice de IndexEndpoint.