Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDataStore

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

Overview

DataStore captures global settings and configs at the DataStore level.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaDataStore

Returns a new instance of GoogleCloudDiscoveryengineV1betaDataStore.



18346
18347
18348
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18346

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

Instance Attribute Details

#advanced_site_search_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig

Configuration data for advance site search. Corresponds to the JSON property advancedSiteSearchConfig

Returns:



18244
18245
18246
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18244

def advanced_site_search_config
  @advanced_site_search_config
end

#billing_estimation ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation

Estimation of data size per data store. Corresponds to the JSON property billingEstimation

Returns:



18249
18250
18251
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18249

def billing_estimation
  @billing_estimation
end

#cmek_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys. Corresponds to the JSON property cmekConfig

Returns:



18254
18255
18256
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18254

def cmek_config
  @cmek_config
end

#content_config ⇒ String

Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. Corresponds to the JSON property contentConfig

Returns:

  • (String) 


18260
18261
18262
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18260

def content_config
  @content_config
end

#create_time ⇒ String

Output only. Timestamp the DataStore was created at. Corresponds to the JSON property createTime

Returns:

  • (String) 


18265
18266
18267
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18265

def create_time
  @create_time
end

#default_schema_id ⇒ String

Output only. The id of the default Schema asscociated to this data store. Corresponds to the JSON property defaultSchemaId

Returns:

  • (String) 


18270
18271
18272
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18270

def default_schema_id
  @default_schema_id
end

#display_name ⇒ String

Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property displayName

Returns:

  • (String) 


18277
18278
18279
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18277

def display_name
  @display_name
end

#document_processing_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. Corresponds to the JSON property documentProcessingConfig

Returns:



18284
18285
18286
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18284

def document_processing_config
  @document_processing_config
end

#industry_vertical ⇒ String

Immutable. The industry vertical that the data store registers. Corresponds to the JSON property industryVertical

Returns:

  • (String) 


18289
18290
18291
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18289

def industry_vertical
  @industry_vertical
end

#is_infobot_faq_data_store ⇒ Boolean Also known as: is_infobot_faq_data_store?

Optional. If set, this DataStore is an Infobot FAQ DataStore. Corresponds to the JSON property isInfobotFaqDataStore

Returns:

  • (Boolean) 


18294
18295
18296
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18294

def is_infobot_faq_data_store
  @is_infobot_faq_data_store
end

#kms_key_name ⇒ String

Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


18303
18304
18305
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18303

def kms_key_name
  @kms_key_name
end

#language_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaLanguageInfo

Language info for DataStore. Corresponds to the JSON property languageInfo

Returns:



18308
18309
18310
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18308

def language_info
  @language_info
end

#name ⇒ String

Immutable. The full resource name of the data store. Format: projects/ project/locations/location/collections/collection_id/dataStores/ data_store_id`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Corresponds to the JSON propertyname`

Returns:

  • (String) 


18316
18317
18318
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18316

def name
  @name
end

#natural_language_query_understanding_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding. Corresponds to the JSON property naturalLanguageQueryUnderstandingConfig

Returns:



18321
18322
18323
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18321

def natural_language_query_understanding_config
  @natural_language_query_understanding_config
end

#serving_config_data_store ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore

Stores information regarding the serving configurations at DataStore level. Corresponds to the JSON property servingConfigDataStore

Returns:



18326
18327
18328
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18326

def serving_config_data_store
  @serving_config_data_store
end

#solution_types ⇒ Array<String>

The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH. * SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled. Corresponds to the JSON property solutionTypes

Returns:

  • (Array<String>) 


18334
18335
18336
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18334

def solution_types
  @solution_types
end

#starting_schema ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSchema

Defines the structure and layout of a type of document data. Corresponds to the JSON property startingSchema

Returns:



18339
18340
18341
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18339

def starting_schema
  @starting_schema
end

#workspace_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaWorkspaceConfig

Config to store data store type configuration for workspace data Corresponds to the JSON property workspaceConfig

Returns:



18344
18345
18346
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18344

def workspace_config
  @workspace_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 18351

def update!(**args)
  @advanced_site_search_config = args[:advanced_site_search_config] if args.key?(:advanced_site_search_config)
  @billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
  @content_config = args[:content_config] if args.key?(:content_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @language_info = args[:language_info] if args.key?(:language_info)
  @name = args[:name] if args.key?(:name)
  @natural_language_query_understanding_config = args[:natural_language_query_understanding_config] if args.key?(:natural_language_query_understanding_config)
  @serving_config_data_store = args[:serving_config_data_store] if args.key?(:serving_config_data_store)
  @solution_types = args[:solution_types] if args.key?(:solution_types)
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
  @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
end