REST Resource: settings.datasources

Resource: DataSource

Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.

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

string

The name of the datasource resource. Format: datasources/{sourceId}.

The name is ignored when creating a datasource.
displayName

string

Required. Display name of the datasource 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 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.
indexingServiceAccounts[]

string

List of service accounts that have indexing access.
disableServing

boolean

Disable serving any search or assist results.
disableModifications

boolean

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.
itemsVisibility[]

object (GSuitePrincipal)

This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this 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 datasource, and that the individual items are not shared outside this visibility.
returnThumbnailUrls

boolean

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

string

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

Methods

create

 Creates a datasource.

delete

 Deletes a datasource.

get

 Gets a datasource.

list

 Lists datasources.

patch

 Updates a datasource.

update

 Updates a datasource.