REST Resource: projects.locations.indexEndpoints

Recurso: IndexEndpoint

Mensagem que representa o recurso IndexEndpoint. Os ImageIndexes são implantados nele.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "deployedIndex": {
    object (DeployedIndex)
  },
  "state": enum (State),
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string
}
Campos
name

string

Apenas saída. Nome do recurso do IndexEndpoint. Formato: projects/{project}/locations/{location}/indexEndpoints/{indexEndpointId}
displayName

string

Opcional. Nome de exibição do IndexEndpoint. Pode ter até 32 caracteres.
description

string

Opcional. Descrição do IndexEndpoint. Pode ter até 25.000 caracteres.
deployedIndex

object (DeployedIndex)

Apenas saída. O índice implantado neste IndexEndpoint.
state

enum (State)

Apenas saída. Estado do IndexEndpoint.
labels

map (key: string, value: string)

Opcional. Os rótulos aplicados a um recurso precisam atender aos seguintes requisitos:

  • Cada recurso pode ter vários rótulos, até um máximo de 64.
  • Cada rótulo precisa ser um par de chave-valor.
  • As chaves têm comprimento mínimo de 1 e máximo de 63 caracteres. Além disso, elas não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres.
  • As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos.
  • A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos.
  • As chaves precisam começar com uma letra minúscula ou um caractere internacional.

Consulte a documentação do Google Cloud para mais detalhes.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Apenas saída. Crie um carimbo de data/hora.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. Atualize o carimbo de data/hora.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

DeployedIndex

Uma implantação de um índice.

Representação JSON 
{
  "index": string
}
Campos
index

string

Obrigatório. Nome do índice implantado. Formato: projects/*/locations/*/corpora/*/indexes/*

Estado

Fase do IndexEndpoint.

Enums
STATE_UNSPECIFIED O valor padrão. Não pode ser usado.
CREATING Estado CRIANDO.
CREATED Estado CREATED.
UPDATING Estado ATUALIZANDO.
FAILED Estado FAILED.

Métodos

create

 Cria um IndexEndpoint.

delete

 Exclui um IndexEndpoint.

deployIndex

 Implanta um índice no IndexEndpoint.

get

 Recebe um IndexEndpoint.

list

 Lista todos os IndexEndpoints em um projeto.

patch

 Atualiza um IndexEndpoint.

searchIndexEndpoint

 Pesquise um endpoint de índice implantado (somente tipo de corpus de IMAGEM).

undeployIndex

 Cancela a implantação de um índice do IndexEndpoint.