Method: settings.datasources.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a datasource.
Note: This API requires an admin account to execute.
HTTP request
PATCH https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
source.name |
string
The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource.
|
Query parameters
| Parameters |
debugOptions |
object (DebugOptions)
Common debug options.
|
updateMask |
string (FieldMask format)
Only applies to settings.datasources.patch. Update mask to control which fields to update. Example field paths: name, 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 source, 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 DataSource.
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.indexinghttps://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 2025-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# Method: settings.datasources.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates a datasource.\n\n**Note:** This API requires an admin account to execute.\n\n### HTTP request\n\n`PATCH https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `source.name` | `string` The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `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 source, that field is cleared. - If the `updateMask` is not present or empty or has the value `*`, then all fields are updated. |\n\n### Request body\n\nThe request body contains an instance of [DataSource](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources#DataSource).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.settings.indexing`\n- `https://www.googleapis.com/auth/cloud_search.settings`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
