Class: OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetGenAiSqlAssistant

Inherits:
DatabaseToolsMcpToolset show all
Defined in:
lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb

Overview

Allows the creation, configuration and management of an McpToolset of type GenAI SQL Assistant.

Constant Summary collapse

DEFAULT_EXECUTION_TYPE_ENUM = 
[
  DEFAULT_EXECUTION_TYPE_SYNCHRONOUS = 'SYNCHRONOUS'.freeze,
  DEFAULT_EXECUTION_TYPE_ASYNCHRONOUS = 'ASYNCHRONOUS'.freeze,
  DEFAULT_EXECUTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from DatabaseToolsMcpToolset

OCI::DatabaseTools::Models::DatabaseToolsMcpToolset::LIFECYCLE_STATE_ENUM, OCI::DatabaseTools::Models::DatabaseToolsMcpToolset::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DatabaseToolsMcpToolset

#compartment_id, #database_tools_mcp_server_id, #defined_tags, #description, #display_name, #freeform_tags, #id, #lifecycle_details, #lifecycle_state, #locks, #system_tags, #time_created, #time_updated, #type, #version

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DatabaseToolsMcpToolset

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseToolsMcpToolsetGenAiSqlAssistant

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 109

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'GENAI_SQL_ASSISTANT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.generative_ai_semantic_store_id = attributes[:'generativeAiSemanticStoreId'] if attributes[:'generativeAiSemanticStoreId']

  raise 'You cannot provide both :generativeAiSemanticStoreId and :generative_ai_semantic_store_id' if attributes.key?(:'generativeAiSemanticStoreId') && attributes.key?(:'generative_ai_semantic_store_id')

  self.generative_ai_semantic_store_id = attributes[:'generative_ai_semantic_store_id'] if attributes[:'generative_ai_semantic_store_id']

  self.tools = attributes[:'tools'] if attributes[:'tools']

  self.default_execution_type = attributes[:'defaultExecutionType'] if attributes[:'defaultExecutionType']

  raise 'You cannot provide both :defaultExecutionType and :default_execution_type' if attributes.key?(:'defaultExecutionType') && attributes.key?(:'default_execution_type')

  self.default_execution_type = attributes[:'default_execution_type'] if attributes[:'default_execution_type']
end

Instance Attribute Details

#default_execution_type ⇒ String

The default execution type for the toolset. The default value is SYNCHRONOUS.

To use ASYNCHRONOUS execution, the MCP Server must have the storage property configured.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 32

def default_execution_type
  @default_execution_type
end

#generative_ai_semantic_store_id ⇒ String

[Required] The OCID of the related Generative AI Semantic Store.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 21

def generative_ai_semantic_store_id
  @generative_ai_semantic_store_id
end

#tools ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetToolDetails>

List of Database Tools GenAI SQL Assistant tools

Returns:



25
26
27
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 25

def tools
  @tools
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'version': :'version',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'display_name': :'displayName',
    'description': :'description',
    'database_tools_mcp_server_id': :'databaseToolsMcpServerId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'locks': :'locks',
    'generative_ai_semantic_store_id': :'generativeAiSemanticStoreId',
    'tools': :'tools',
    'default_execution_type': :'defaultExecutionType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'version': :'Integer',
    'compartment_id': :'String',
    'type': :'String',
    'display_name': :'String',
    'description': :'String',
    'database_tools_mcp_server_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>',
    'generative_ai_semantic_store_id': :'String',
    'tools': :'Array<OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetToolDetails>',
    'default_execution_type': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 154

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    version == other.version &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    display_name == other.display_name &&
    description == other.description &&
    database_tools_mcp_server_id == other.database_tools_mcp_server_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    locks == other.locks &&
    generative_ai_semantic_store_id == other.generative_ai_semantic_store_id &&
    tools == other.tools &&
    default_execution_type == other.default_execution_type
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 201

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 181

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 190

def hash
  [id, version, compartment_id, type, display_name, description, database_tools_mcp_server_id, lifecycle_state, lifecycle_details, time_created, time_updated, defined_tags, freeform_tags, system_tags, locks, generative_ai_semantic_store_id, tools, default_execution_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 234

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



228
229
230
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_gen_ai_sql_assistant.rb', line 228

def to_s
  to_hash.to_s
end