Method: settings.searchapplications.patch
Updates a search application.
Note: This API requires an admin account to execute.
HTTP request
PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
searchApplication.name |
string
The name of the Search Application. Format: searchapplications/{applicationId}.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Only applies to settings.searchapplications.patch. Update mask to control which fields to update. Example field paths: searchApplication.name, searchApplication.displayName.
- If
updateMask is non-empty, then only the fields specified in the updateMask are updated.
- If you specify a field in the
updateMask, but don't specify its value in the searchApplication, then that field is cleared.
- If the
updateMask is not present or empty or has the value *, then all fields are updated.
|
Request body
The request body contains an instance of SearchApplication.
Response body
If successful, the response body contains an instance of Operation.
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud_search.settings.queryhttps://www.googleapis.com/auth/cloud_search.settingshttps://www.googleapis.com/auth/cloud_search
For more information, see the Authorization guide.
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 2024-09-03 UTC.
[null,null,["Last updated 2024-09-03 UTC."],[[["This API updates a search application using an HTTP PATCH request and requires an admin account."],["The request requires a path parameter `searchApplication.name` to specify the application, and an optional `updateMask` query parameter to control which fields are updated."],["The request body should contain a `SearchApplication` object with the desired changes."],["Upon success, the API returns an `Operation` object in the response body."],["Authorization requires one of the specified OAuth scopes, such as `https://www.googleapis.com/auth/cloud_search.settings.query`."]]],[]]
