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

Updates a CannedQuery.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{cannedQuery.name=projects/*/locations/*/collections/*/engines/*/assistants/*/cannedQueries/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
cannedQuery.name

string

Immutable. Resource name of the canned query. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

It must be a UTF-8 encoded string with a length limit of 1024 characters.

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of CannedQuery.

Response body

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

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.