Method: projects.locations.collections.list

Recebe uma lista de Collections.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/collections

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da repositório de dados principal, no formato projects/{project}/locations/{location}.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de Collections a serem retornados. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo 100 Collections serão retornados.

O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
pageToken

string

Um token de página recebido de uma chamada CollectionService.ListCollections anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para CollectionService.ListCollections precisam corresponder à chamada que forneceu o token da página.
filter

string

Filtre as coleções retornadas por fontes de dados associadas ao conector de dados. Por exemplo, filter = 'dataSource:jira confluence'. Se o filtro estiver vazio, vamos retornar todas as coleções em um projeto e local.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método CollectionService.ListCollections.

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

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

object (Collection)

Os Collections.
nextPageToken

string

Um token que pode ser enviado como ListCollectionsRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

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

  • discoveryengine.collections.list

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