Method: projects.locations.sampleQuerySets.sampleQueries.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1alpha/{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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint updates an existing SampleQuery resource, identified by its full resource name in the URL path."],["The HTTP request uses the `PATCH` method with a specified URL structure for updating the SampleQuery."],["The `updateMask` query parameter allows for partial updates, specifying which fields of the SampleQuery should be modified, otherwise all are updated."],["The request body must include an instance of the SampleQuery resource with the desired updates, and a successful response will also contain an instance of the updated SampleQuery."],["Updating a SampleQuery requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the IAM permission `discoveryengine.sampleQueries.update`."]]],[]]
