class Google::Apis::CloudsearchV1::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.

Attributes

disable_modifications[RW]

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. Corresponds to the JSON property `disableModifications` @return [Boolean]

disable_modifications?[RW]

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. Corresponds to the JSON property `disableModifications` @return [Boolean]

disable_serving[RW]

Disable serving any search or assist results. Corresponds to the JSON property `disableServing` @return [Boolean]

disable_serving?[RW]

Disable serving any search or assist results. Corresponds to the JSON property `disableServing` @return [Boolean]

display_name[RW]

Required. Display name of the datasource The maximum length is 300 characters. Corresponds to the JSON property `displayName` @return [String]

indexing_service_accounts[RW]

List of service accounts that have indexing access. Corresponds to the JSON property `indexingServiceAccounts` @return [Array<String>]

items_visibility[RW]

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. Corresponds to the JSON property `itemsVisibility` @return [Array<Google::Apis::CloudsearchV1::GSuitePrincipal>]

name[RW]

Name of the datasource resource. Format: datasources/`source_id`. The name is ignored when creating a datasource. Corresponds to the JSON property `name` @return [String]

operation_ids[RW]

IDs of the Long Running Operations (LROs) currently running for this schema. Corresponds to the JSON property `operationIds` @return [Array<String>]

short_name[RW]

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. Corresponds to the JSON property `shortName` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudsearch_v1/classes.rb, line 412
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudsearch_v1/classes.rb, line 417
def update!(**args)
  @disable_modifications = args[:disable_modifications] if args.key?(:disable_modifications)
  @disable_serving = args[:disable_serving] if args.key?(:disable_serving)
  @display_name = args[:display_name] if args.key?(:display_name)
  @indexing_service_accounts = args[:indexing_service_accounts] if args.key?(:indexing_service_accounts)
  @items_visibility = args[:items_visibility] if args.key?(:items_visibility)
  @name = args[:name] if args.key?(:name)
  @operation_ids = args[:operation_ids] if args.key?(:operation_ids)
  @short_name = args[:short_name] if args.key?(:short_name)
end