Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1344223223.6 KB
settings

Updates a datasource. Note: This API requires an admin account to execute.

patch/v1/settings/{+name}

Path parameters

namestring required

The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

Query parameters

debugOptions.enableDebuggingboolean

If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

updateMaskstring

Only applies to settings.datasources.patch. Update mask to control which fields to update. Example field paths: name, displayName. * If update_mask is non-empty, then only the fields specified in the update_mask are updated. * If you specify a field in the update_mask, but don't specify its value in the source, that field is cleared. * If the update_mask is not present or empty or has the value *, then all fields are updated.

Request body

namestring

The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

disableServingboolean

Disable serving any search or assist results.

returnThumbnailUrlsboolean

Can a user request to get thumbnail URI for Items indexed in this data source.

operationIdsstring[]

IDs of the Long Running Operations (LROs) currently running for this schema.

disableModificationsboolean

If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.

displayNamestring

Required. Display name of the datasource The maximum length is 300 characters.

shortNamestring

A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is <value> then queries like source:<value> will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

indexingServiceAccountsstring[]

List of service accounts that have indexing access.

Response

Successful response