Class: Google::Apis::CloudsearchV1::DataSource

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DataSource

Returns a new instance of DataSource.



6229
6230
6231
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6229

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disable_modifications ⇒ Boolean Also known as: disable_modifications?

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

Returns:

  • (Boolean) 


6172
6173
6174
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6172

def disable_modifications
  @disable_modifications
end

#disable_serving ⇒ Boolean Also known as: disable_serving?

Disable serving any search or assist results. Corresponds to the JSON property disableServing

Returns:

  • (Boolean) 


6178
6179
6180
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6178

def disable_serving
  @disable_serving
end

#display_name ⇒ String

Required. Display name of the datasource The maximum length is 300 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


6184
6185
6186
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6184

def display_name
  @display_name
end

#indexing_service_accounts ⇒ Array<String>

List of service accounts that have indexing access. Corresponds to the JSON property indexingServiceAccounts

Returns:

  • (Array<String>) 


6189
6190
6191
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6189

def indexing_service_accounts
  @indexing_service_accounts
end

#items_visibility ⇒ Array<Google::Apis::CloudsearchV1::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. Corresponds to the JSON property itemsVisibility

Returns:



6199
6200
6201
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6199

def items_visibility
  @items_visibility
end

#name ⇒ String

The name of the datasource resource. Format: datasources/source_id. The name is ignored when creating a datasource. Corresponds to the JSON property name

Returns:

  • (String) 


6205
6206
6207
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6205

def name
  @name
end

#operation_ids ⇒ Array<String>

IDs of the Long Running Operations (LROs) currently running for this schema. Corresponds to the JSON property operationIds

Returns:

  • (Array<String>) 


6210
6211
6212
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6210

def operation_ids
  @operation_ids
end

#return_thumbnail_urls ⇒ Boolean Also known as: return_thumbnail_urls?

Can a user request to get thumbnail URI for Items indexed in this data source. Corresponds to the JSON property returnThumbnailUrls

Returns:

  • (Boolean) 


6215
6216
6217
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6215

def return_thumbnail_urls
  @return_thumbnail_urls
end

#short_name ⇒ 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 then queries like source: 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

Returns:

  • (String) 


6227
6228
6229
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6227

def short_name
  @short_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6234

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)
  @return_thumbnail_urls = args[:return_thumbnail_urls] if args.key?(:return_thumbnail_urls)
  @short_name = args[:short_name] if args.key?(:short_name)
end