Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Engine

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

Metadata that describes the training and serving parameters of an Engine.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Engine

Returns a new instance of GoogleCloudDiscoveryengineV1Engine.



4258
4259
4260
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4258

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

Instance Attribute Details

#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineChatEngineConfig

Configurations for a Chat Engine. Corresponds to the JSON property chatEngineConfig

Returns:



4187
4188
4189
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4187

def chat_engine_config
  @chat_engine_config
end

#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineChatEngineMetadata

Additional information of a Chat Engine. Fields in this message are output only. Corresponds to the JSON property chatEngineMetadata

Returns:



4193
4194
4195
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4193

def chat_engine_metadata
  @chat_engine_metadata
end

#common_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineCommonConfig

Common configurations for an Engine. Corresponds to the JSON property commonConfig

Returns:



4198
4199
4200
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4198

def common_config
  @common_config
end

#create_time ⇒ String

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

Returns:

  • (String) 


4203
4204
4205
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4203

def create_time
  @create_time
end

#data_store_ids ⇒ Array<String>

The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. Corresponds to the JSON property dataStoreIds

Returns:

  • (Array<String>) 


4213
4214
4215
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4213

def data_store_ids
  @data_store_ids
end

#disable_analytics ⇒ Boolean Also known as: disable_analytics?

Optional. Whether to disable analytics for searches performed on this engine. Corresponds to the JSON property disableAnalytics

Returns:

  • (Boolean) 


4218
4219
4220
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4218

def disable_analytics
  @disable_analytics
end

#display_name ⇒ String

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


4225
4226
4227
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4225

def display_name
  @display_name
end

#industry_vertical ⇒ String

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore linked to the engine. Corresponds to the JSON property industryVertical

Returns:

  • (String) 


4232
4233
4234
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4232

def industry_vertical
  @industry_vertical
end

#name ⇒ String

Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/project/locations/location/collections/collection/engines/ engine`engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON propertyname`

Returns:

  • (String) 


4241
4242
4243
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4241

def name
  @name
end

#search_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineSearchEngineConfig

Configurations for a Search Engine. Corresponds to the JSON property searchEngineConfig

Returns:



4246
4247
4248
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4246

def search_engine_config
  @search_engine_config
end

#solution_type ⇒ String

Required. The solutions of the engine. Corresponds to the JSON property solutionType

Returns:

  • (String) 


4251
4252
4253
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4251

def solution_type
  @solution_type
end

#update_time ⇒ String

Output only. Timestamp the Recommendation Engine was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4256
4257
4258
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4256

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4263

def update!(**args)
  @chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
  @chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
  @common_config = args[:common_config] if args.key?(:common_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
  @display_name = args[:display_name] if args.key?(:display_name)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @name = args[:name] if args.key?(:name)
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
  @solution_type = args[:solution_type] if args.key?(:solution_type)
  @update_time = args[:update_time] if args.key?(:update_time)
end