Method: projects.locations.collections.list

Gets a list of Collections.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}.

Query parameters

Parameters
pageSize

integer

The maximum number of Collections to return. The service may return fewer than this value.

If unspecified, at most 100 Collections will be returned.

The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token.
filter

string

Filter returned collections by associated data connector data sources. For example: filter = 'dataSource:jira confluence'. If the filter is empty, we return all collections under a project and location.

Request body

The request body must be empty.

Response body

Response message for CollectionService.ListCollections method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Fields
collections[]

object (Collection)

The Collections.
nextPageToken

string

A token that can be sent as ListCollectionsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.collections.list

For more information, see the IAM documentation.