Class: Google::Apis::CloudsearchV1::DataSource
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::DataSource
- 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
-
#disable_modifications ⇒ Boolean
(also: #disable_modifications?)
If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete.
-
#disable_serving ⇒ Boolean
(also: #disable_serving?)
Disable serving any search or assist results.
-
#display_name ⇒ String
Required.
-
#indexing_service_accounts ⇒ Array<String>
List of service accounts that have indexing access.
-
#items_visibility ⇒ Array<Google::Apis::CloudsearchV1::GSuitePrincipal>
This field restricts visibility to items at the datasource level.
-
#name ⇒ String
Name of the datasource resource.
-
#operation_ids ⇒ Array<String>
IDs of the Long Running Operations (LROs) currently running for this schema.
-
#short_name ⇒ String
A short name or alias for the source.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DataSource
constructor
A new instance of DataSource.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ DataSource
Returns a new instance of DataSource.
317 318 319 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 317 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
261 262 263 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 261 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
267 268 269 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 267 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
274 275 276 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 274 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
279 280 281 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 279 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.
This should not be set if anonymous search is enabled for the data source.
Corresponds to the JSON property itemsVisibility
290 291 292 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 290 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
297 298 299 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 297 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
303 304 305 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 303 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
315 316 317 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 315 def short_name @short_name end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
322 323 324 325 326 327 328 329 330 331 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 322 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 |