Method: projects.locations.collections.list

Obtiene una lista de Collections.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso de almacén de datos principal, en el formato projects/{project}/locations/{location}.

Parámetros de consulta

Parámetros
pageSize

integer

Es la cantidad máxima de Collection que se devolverán. El servicio puede mostrar menos que este valor.

Si no se especifica, se devolverán, como máximo, 100 Collections.

El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.
pageToken

string

Un token de página, recibido desde una llamada CollectionService.ListCollections anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a CollectionService.ListCollections deben coincidir con la llamada que proporcionó el token de la página.
filter

string

Filtra las colecciones devueltas por las fuentes de datos del conector de datos asociado. Por ejemplo: filter = 'dataSource:jira confluence'. Si el filtro está vacío, devolvemos todas las colecciones de un proyecto y una ubicación.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para el método CollectionService.ListCollections.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Campos
collections[]

object (Collection)

Los Collection.
nextPageToken

string

Es un token que se puede enviar como ListCollectionsRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.collections.list

Para obtener más información, consulta la documentación de IAM.