Method: projects.locations.collections.engines.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1beta/{engine.name=projects/*/locations/*/collections/*/engines/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
engine.name |
string
Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. 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 Engine.
Response body
If successful, the response body contains an instance of Engine.
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.engines.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 webpage details how to update an Engine resource using a PATCH HTTP request to a specified URL."],["The URL path requires a `engine.name` parameter, following a specific format and character limit, to identify the target Engine."],["The `updateMask` query parameter dictates which fields of the Engine are to be modified during the update, using a comma-separated list."],["The request body must contain an instance of the Engine object with the updated values, and the response body will also contain an instance of the updated Engine upon successful completion."],["To perform this update, the request must be authorized with the `https://www.googleapis.com/auth/cloud-platform` OAuth scope, and the `discoveryengine.engines.update` IAM permission on the engine's resource."]]],[]]
