Method: projects.locations.collections.engines.controls.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a Control.
Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1/{control.name=projects/*/locations/*/collections/*/engines/*/controls/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
control.name |
string
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Optional. Indicates which fields in the provided Control to update. The following are NOT supported:
If not set or empty, all supported fields are updated. 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 Control.
Response body
If successful, the response body contains an instance of Control.
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.controls.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 facilitates the updating of an existing Control resource, identified by its fully qualified name, within the system."],["The HTTP request utilizes the `PATCH` method, and the Control's name is specified within the URL path, using the provided gRPC Transcoding syntax."],["The `updateMask` query parameter is used to specify which fields of the Control to update, and it is mandatory to specify, otherwise all supported fields are updated, and updating `Control.name` or `Control.solution_type` is unsupported."],["Successful updates return an instance of the updated Control in the response body, and a NOT_FOUND error is returned if the Control to update does not exist."],["Updating this control requires specific authentication scopes and IAM permissions, specifically `https://www.googleapis.com/auth/cloud-platform` and `discoveryengine.controls.update`, respectively."]]],[]]
