Method: projects.locations.collections.engines.list

Lists all the Engines 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

string

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

Query parameters

Parameters
pageSize

integer

Optional. Not supported.
pageToken

string

Optional. Not supported.
filter

string

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 (Engine)
    }
  ],
  "nextPageToken": string
}
Fields
engines[]

object (Engine)

All the customer's Engines.
nextPageToken

string

Not supported.

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.engines.list

For more information, see the IAM documentation.