Method: projects.locations.collections.engines.servingConfigs.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a ServingConfig.
Returns a NOT_FOUND error if the ServingConfig does not exist.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1/{servingConfig.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
servingConfig.name |
string
Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Indicates which fields in the provided ServingConfig to update. The following are NOT supported:
If not set, 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 ServingConfig.
Response body
If successful, the response body contains an instance of ServingConfig.
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.servingConfigs.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 a ServingConfig using a PATCH request to the specified URL, which is in gRPC Transcoding syntax."],["The update operation requires a `servingConfig.name` path parameter to identify the specific ServingConfig and an optional `updateMask` query parameter to control which fields are updated."],["The request body contains the updated ServingConfig details, while the successful response body also returns an instance of the updated ServingConfig."],["To perform this operation, the request needs to be authorized with the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the `discoveryengine.servingConfigs.update` IAM permission on the specified resource."],["If a serving config is not found, a `NOT_FOUND` error will be thrown."]]],[]]
