REST Resource: settings.datasources

Resource: DataSource

Data source is a logical namespace for items to be indexed. All items must belong to a data source. This is the prerequisite before items can be indexed into Cloud query.search.

JSON representation
{
  "name": string,
  "displayName": string,
  "shortName": string,
  "indexingServiceAccounts": [
    string
  ],
  "disableServing": boolean,
  "disableModifications": boolean,
  "itemsVisibility": [
    {
      object(GSuitePrincipal)
    }
  ],
  "operationIds": [
    string
  ]
}
Fields
name

string

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

displayName

string

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

shortName

string

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 data sources. 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. Its maximum length is 32 characters.

indexingServiceAccounts[]

string

List of service accounts that have indexing access.

disableServing

boolean

Disable serving any search or assist results.

disableModifications

boolean

If true, Indexing API rejects any modification calls to this data source such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.

itemsVisibility[]

object(GSuitePrincipal)

This restricts visibility to items at a data source level to the disjunction of users/groups mentioned with the field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire data source, and that the individual items are not shared outside this visibility.

operationIds[]

string

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

Methods

create

Creates data source.

delete

Deletes a data source.

get

Gets a data source.

list

Lists data sources.

update

Updates a data source.

Send feedback about...

Cloud Search
Cloud Search