Class: OCI::DatabaseTools::Models::CreateDatabaseToolsMcpToolsetDetails

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

Overview

Details for the new Database Tools MCP server. 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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseToolsMcpToolsetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 126

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.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.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.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.description = attributes[:'description'] if attributes[:'description']

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

  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.locks = attributes[:'locks'] if attributes[:'locks']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the Database Tools MCP server.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#database_tools_mcp_server_id ⇒ String

[Required] The OCID of the Database Tools MCP Server

Returns:

  • (String) 


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

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


47
48
49
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 47

def defined_tags
  @defined_tags
end

#description ⇒ String

A human readable description of the Database Tools MCP toolset.

Returns:

  • (String) 


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

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) 


29
30
31
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 29

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


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

def freeform_tags
  @freeform_tags
end

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

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#type ⇒ String

[Required] The Database Tools MCP Toolset type.

Returns:

  • (String) 


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

def type
  @type
end

#version ⇒ Integer

[Required] The MCP toolset version

Returns:

  • (Integer) 


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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'version': :'version',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'database_tools_mcp_server_id': :'databaseToolsMcpServerId',
    'description': :'description',
    'type': :'type',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    '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.



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 98

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

  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsMcpToolsetBuiltInSqlToolsDetails' if type == 'BUILT_IN_SQL_TOOLS'
  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsMcpToolsetCustomSqlToolDetails' if type == 'CUSTOM_SQL_TOOL'
  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsMcpToolsetGenAiSqlAssistantDetails' if type == 'GENAI_SQL_ASSISTANT'
  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsMcpToolsetCustomizableReportingToolsDetails' if type == 'CUSTOMIZABLE_REPORTING_TOOLS'

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

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'version': :'Integer',
    'compartment_id': :'String',
    'display_name': :'String',
    'database_tools_mcp_server_id': :'String',
    'description': :'String',
    'type': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    '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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 186

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

  self.class == other.class &&
    version == other.version &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    database_tools_mcp_server_id == other.database_tools_mcp_server_id &&
    description == other.description &&
    type == other.type &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 224

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


204
205
206
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 204

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 213

def hash
  [version, compartment_id, display_name, database_tools_mcp_server_id, description, type, defined_tags, freeform_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



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 257

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



251
252
253
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_details.rb', line 251

def to_s
  to_hash.to_s
end