Method: projects.locations.collections.list

Lista as coleções em determinado projeto e local.

Solicitação HTTP

GET https://vectorsearch.googleapis.com/v1/{parent}/collections

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Valor principal para ListCollectionsRequest

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
pageToken

string

Opcional. Um token que identifica a página de resultados que o servidor vai retornar.
filter

string

Opcional. Como filtrar resultados
orderBy

string

Opcional. Dica de como organizar os resultados

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para listar coleções

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
collections[]

object (Collection)

A lista de coleções
nextPageToken

string

Um token que identifica a página de resultados que o servidor retornará.
unreachable[]

string

Lista não ordenada. Locais que não puderam ser alcançados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • vectorsearch.collections.list

Para mais informações, consulte a documentação do IAM.