Method: projects.locations.collections.list

Ruft eine Liste von Collection ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Datenspeicherressource im Format projects/{project}/locations/{location}.

Abfrageparameter

Parameter
pageSize

integer

Die maximale Anzahl der zurückzugebenden Collection. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 100 Collection zurückgegeben.

Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.
pageToken

string

Ein Seitentoken, das von einem vorherigen CollectionService.ListCollections-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für CollectionService.ListCollections bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
filter

string

Zurückgegebene Sammlungen nach zugehörigen Datenquellen des Daten-Connectors filtern. Beispiel: filter = 'dataSource:jira confluence'. Wenn der Filter leer ist, werden alle Sammlungen unter einem Projekt und einem Standort zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode CollectionService.ListCollections.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Felder
collections[]

object (Collection)

Die Collection.
nextPageToken

string

Ein Token, das als ListCollectionsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.collections.list

Weitere Informationen finden Sie in der IAM-Dokumentation.