Class: OCI::DatabaseTools::Models::DatabaseToolsMcpToolset

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools/models/database_tools_mcp_toolset.rb

Overview

Allows the creation, configuration and management of an MCP Toolset. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_CUSTOM_SQL_TOOL = 'CUSTOM_SQL_TOOL'.freeze,
  TYPE_BUILT_IN_SQL_TOOLS = 'BUILT_IN_SQL_TOOLS'.freeze,
  TYPE_CUSTOMIZABLE_REPORTING_TOOLS = 'CUSTOMIZABLE_REPORTING_TOOLS'.freeze,
  TYPE_GENAI_SQL_ASSISTANT = 'GENAI_SQL_ASSISTANT'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseToolsMcpToolset

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :version (Integer) —

    The value to assign to the #version property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :type (String) —

    The value to assign to the #type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :database_tools_mcp_server_id (String) —

    The value to assign to the #database_tools_mcp_server_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :locks (Array<OCI::DatabaseTools::Models::ResourceLock>) —

    The value to assign to the #locks property



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 182

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

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.database_tools_mcp_server_id = attributes[:'databaseToolsMcpServerId'] if attributes[:'databaseToolsMcpServerId']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment to move the Database Tools MCP Toolset to.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 41

def compartment_id
  @compartment_id
end

#database_tools_mcp_server_id ⇒ String

[Required] The OCID of the related Database Tools McpServer.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 57

def database_tools_mcp_server_id
  @database_tools_mcp_server_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


79
80
81
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 79

def defined_tags
  @defined_tags
end

#description ⇒ String

A human readable description of the Database Tools MCP toolset.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 53

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 49

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


85
86
87
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 85

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Database Tools MCP Toolsets.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 33

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 65

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Database Tools MCP Toolset.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 61

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>

Locks associated with this resource.

Returns:



95
96
97
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 95

def locks
  @locks
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


91
92
93
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 91

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the Database Tools MCP server was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 69

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 73

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The Database Tools MCP Toolset type.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 45

def type
  @type
end

#version ⇒ Integer

[Required] The MCP toolset version

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 37

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 98

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 148

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetCustomSqlTool' if type == 'CUSTOM_SQL_TOOL'
  return 'OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetGenAiSqlAssistant' if type == 'GENAI_SQL_ASSISTANT'
  return 'OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetCustomizableReportingTools' if type == 'CUSTOMIZABLE_REPORTING_TOOLS'
  return 'OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetBuiltInSqlTools' if type == 'BUILT_IN_SQL_TOOLS'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseTools::Models::DatabaseToolsMcpToolset'
end

.swagger_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 121

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 292

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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 336

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


316
317
318
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 316

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



325
326
327
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 325

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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



369
370
371
372
373
374
375
376
377
378
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 369

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



363
364
365
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset.rb', line 363

def to_s
  to_hash.to_s
end