Method: projects.locations.collections.list

Obtient une liste de Collection.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource du data store parent, au format projects/{project}/locations/{location}.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de Collection à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 100 Collection au maximum sont renvoyés.

La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
pageToken

string

Jeton de page reçu d'un appel CollectionService.ListCollections précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à CollectionService.ListCollections doivent correspondre à l'appel ayant fourni le jeton de page.
filter

string

Filtrez les collections renvoyées par sources de données de connecteur de données associées. Exemple : filter = 'dataSource:jira confluence'. Si le filtre est vide, nous renvoyons toutes les collections d'un projet et d'un emplacement.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la méthode CollectionService.ListCollections.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Champs
collections[]

object (Collection)

Les Collections.
nextPageToken

string

Jeton pouvant être envoyé en tant que ListCollectionsRequest.page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.collections.list

Pour en savoir plus, consultez la documentation IAM.