Method: projects.locations.collections.list

Recupera un elenco di Collection.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa del datastore padre, nel formato projects/{project}/locations/{location}.

Parametri di query

Parametri
pageSize

integer

Il numero massimo di Collection da restituire. Il servizio può restituire un numero inferiore a questo valore.

Se non specificato, verranno restituite al massimo 100 Collection.

Il valore massimo è 1000; i valori superiori a 1000 verranno forzati a 1000.
pageToken

string

Un token di pagina, ricevuto da una precedente chiamata CollectionService.ListCollections. Forniscilo per recuperare la pagina successiva.

Quando esegui la paginazione, tutti gli altri parametri forniti a CollectionService.ListCollections devono corrispondere alla chiamata che ha fornito il token di pagina.
filter

string

Filtra le raccolte restituite in base alle origini dati del connettore dati associato. Ad esempio: filter = 'dataSource:jira confluence'. Se il filtro è vuoto, restituiamo tutte le raccolte in un progetto e una località.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per il metodo CollectionService.ListCollections.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Campi
collections[]

object (Collection)

Le Collection.
nextPageToken

string

Un token che può essere inviato come ListCollectionsRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.collections.list

Per saperne di più, consulta la documentazione di IAM.