Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore

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

Returns a new instance of GoogleCloudDiscoveryengineV1DataStore.



3339
3340
3341
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3339

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

Instance Attribute Details

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


3277
3278
3279
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3277

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) 


3282
3283
3284
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3282

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) 


3287
3288
3289
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3287

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) 


3294
3295
3296
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3294

def display_name
  @display_name
end

#document_processing_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentProcessingConfig

A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService. UpdateDocumentProcessingConfig method will initialize the config. Corresponds to the JSON property documentProcessingConfig

Returns:



3301
3302
3303
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3301

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) 


3306
3307
3308
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3306

def industry_vertical
  @industry_vertical
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) 


3314
3315
3316
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3314

def name
  @name
end

#serving_config_data_store ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfigDataStore

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

Returns:



3319
3320
3321
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3319

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


3327
3328
3329
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3327

def solution_types
  @solution_types
end

#starting_schema ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema

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

Returns:



3332
3333
3334
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3332

def starting_schema
  @starting_schema
end

#workspace_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WorkspaceConfig

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

Returns:



3337
3338
3339
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3337

def workspace_config
  @workspace_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3344

def update!(**args)
  @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)
  @name = args[:name] if args.key?(:name)
  @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