Method: projects.locations.dataStores.list

Lists all the DataStore s associated with the project.

HTTP request

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*}/dataStores

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collectionId} .

If the caller does not have permission to list DataStore s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters
pageSize

integer

Maximum number of DataStore s to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50.

If this field is negative, an INVALID_ARGUMENT is returned.

pageToken

string

A page token ListDataStoresResponse.next_page_token , received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

filter

string

Filter by solution type . For example: filter = 'solutionType:SOLUTION_TYPE_SEARCH'

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListDataStoresResponse .

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.dataStores.list

For more information, see the IAM documentation .

Design a Mobile Site
View Site in Mobile | Classic
Share by: