Method: indexing.datasources.updateSchema
Stay organized with collections
Save and categorize content based on your preferences.
Updates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema.
Note: This API requires an admin or service account to execute.
HTTP request
PUT https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/schema
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The name of the data source to update Schema. Format: datasources/{sourceId}
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"validateOnly": boolean,
"schema": {
object (Schema)
},
"debugOptions": {
object (DebugOptions)
}
} |
| Fields |
validateOnly |
boolean
If true, the schema will be checked for validity, but will not be registered with the data source, even if valid.
|
schema |
object (Schema)
The new schema for the source.
|
debugOptions |
object (DebugOptions)
Common debug options.
|
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: indexing.datasources.updateSchema\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema.\n\n**Note:** This API requires an admin or service account to execute.\n\n### HTTP request\n\n`PUT https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/schema`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------|\n| `name` | `string` The name of the data source to update Schema. Format: datasources/{sourceId} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"validateOnly\": boolean, \"schema\": { object (/workspace/cloud-search/docs/reference/rest/v1/Schema) }, \"debugOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/DebugOptions) } } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `validateOnly` | `boolean` If true, the schema will be checked for validity, but will not be registered with the data source, even if valid. |\n| `schema` | `object (`[Schema](/workspace/cloud-search/docs/reference/rest/v1/Schema)`)` The new schema for the source. |\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\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)."]]
