Method: projects.locations.collections.dataStores.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the DataStores associated with the project.
HTTP request
GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*}/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 DataStores 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 DataStores 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint retrieves a list of DataStores associated with a specified project, location, and collection."],["The HTTP request uses a GET method with a specific URL structure based on gRPC Transcoding syntax, including the project, location, and collection in the path."],["The `parent` path parameter is required to define the branch resource, and a permission error will return if the caller does not have access."],["Query parameters allow for pagination (`pageSize` and `pageToken`) and filtering by solution type, such as `solutionType:SOLUTION_TYPE_SEARCH`."],["To successfully interact with this endpoint, you need to have the `discoveryengine.dataStores.list` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
