Method: projects.locations.collections.engines.assistants.cannedQueries.list

Lists all CannedQuerys under an Assistant.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Query parameters

Parameters
filter

string

Optional. The filter expression.

Supported fields:

  • enabled
  • googleDefined

Examples:

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
pageToken

string

A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for the CannedQueryService.ListCannedQueries method.

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

JSON representation 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
Fields
cannedQueries[]

object (CannedQuery)

The list of CannedQuerys matching the request.
nextPageToken

string

A token that can be sent as ListCannedQueriesRequest.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
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

For more information, see the Authentication Overview.