- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
Lists all the Engine
s associated with the project.
HTTP request
GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*}/engines
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent resource name, such as |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. Not supported. |
pageToken |
Optional. Not supported. |
filter |
Optional. Filter by solution type. For example: solutionType=SOLUTION_TYPE_SEARCH |
Request body
The request body must be empty.
Response body
Response message for EngineService.ListEngines
method.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"engines": [
{
object ( |
Fields | |
---|---|
engines[] |
All the customer's |
nextPageToken |
Not supported. |
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.engines.list
For more information, see the IAM documentation.