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.



4042
4043
4044
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4042

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:



3977
3978
3979
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3977

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:



3983
3984
3985
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3983

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:



3988
3989
3990
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3988

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) 


3993
3994
3995
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3993

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


4003
4004
4005
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4003

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


4009
4010
4011
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4009

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) 


4016
4017
4018
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4016

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) 


4025
4026
4027
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4025

def name
  @name
end

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

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

Returns:



4030
4031
4032
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4030

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) 


4035
4036
4037
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4035

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) 


4040
4041
4042
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4040

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4047

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