Method: projects.locations.collections.list

Obtém uma lista de Collections.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da loja 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 devolver. O serviço pode devolver um número inferior a este valor.

Se não for especificado, são devolvidos, no máximo, 100 Collections.

O valor máximo é 1000. Os valores superiores a 1000 são convertidos para 1000.
pageToken

string

Um token de página, recebido de uma chamada CollectionService.ListCollections anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a CollectionService.ListCollections têm de corresponder à chamada que forneceu o token da página.
filter

string

Filtre as coleções devolvidas por origens de dados do conetor de dados associadas. Por exemplo: filter = 'dataSource:jira confluence'. Se o filtro estiver vazio, devolvemos todas as coleções de um projeto e uma localização.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

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

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (Collection)

Os anos Collection.
nextPageToken

string

Um token que pode ser enviado como ListCollectionsRequest.page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.collections.list

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