Method: projects.locations.sampleQuerySets.sampleQueries.patch

Updates a SampleQuery.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1beta/{sampleQuery.name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
sampleQuery.name

string

Identifier. The full resource name of the sample query, in the format of projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}.

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

Query parameters

Parameters
updateMask

string (FieldMask format)

Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.

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 SampleQuery.

Response body

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

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 name resource:

  • discoveryengine.sampleQueries.update

For more information, see the IAM documentation.