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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DataSource

Returns a new instance of DataSource



217
218
219
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 217

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

Instance Attribute Details

#disable_modifications ⇒ Boolean Also known as: disable_modifications?

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

Returns:

  • (Boolean) 


162
163
164
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 162

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) 


168
169
170
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 168

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) 


175
176
177
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 175

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>) 


180
181
182
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 180

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:



190
191
192
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 190

def items_visibility
  @items_visibility
end

#name ⇒ String

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) 


197
198
199
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 197

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>) 


203
204
205
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 203

def operation_ids
  @operation_ids
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 <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

Returns:

  • (String) 


215
216
217
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 215

def short_name
  @short_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



222
223
224
225
226
227
228
229
230
231
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 222

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