Method: indexing.datasources.updateSchema

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 a 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

Name of the data source to update Schema. Format: datasources/{source_id}

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.indexing
  • https://www.googleapis.com/auth/cloud_search.settings
  • https://www.googleapis.com/auth/cloud_search

For more information, see the OAuth 2.0 Overview.