Class: OCI::DatabaseTools::Models::DatabaseToolsMcpServer

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

Overview

Allows the creation, configuration and management of an 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

Direct Known Subclasses

DatabaseToolsMcpServerDefault

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_DEFAULT = 'DEFAULT'.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_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RUNTIME_IDENTITY_ENUM = 
[
  RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL = 'AUTHENTICATED_PRINCIPAL'.freeze,
  RUNTIME_IDENTITY_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'.freeze,
  RUNTIME_IDENTITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseToolsMcpServer

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 226

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

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

  self.database_tools_connection_id = attributes[:'databaseToolsConnectionId'] if attributes[:'databaseToolsConnectionId']

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

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

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

  self.built_in_roles = attributes[:'builtInRoles'] if attributes[:'builtInRoles']

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

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

  self.custom_roles = attributes[:'customRoles'] if attributes[:'customRoles']

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

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

  self.access_token_expiry_in_seconds = attributes[:'accessTokenExpiryInSeconds'] if attributes[:'accessTokenExpiryInSeconds']

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

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

  self.refresh_token_expiry_in_seconds = attributes[:'refreshTokenExpiryInSeconds'] if attributes[:'refreshTokenExpiryInSeconds']

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

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

  self.related_resource = attributes[:'relatedResource'] if attributes[:'relatedResource']

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

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

  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.runtime_identity = attributes[:'runtimeIdentity'] if attributes[:'runtimeIdentity']
  self.runtime_identity = "AUTHENTICATED_PRINCIPAL" if runtime_identity.nil? && !attributes.key?(:'runtimeIdentity') # rubocop:disable Style/StringLiterals

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

  self.runtime_identity = attributes[:'runtime_identity'] if attributes[:'runtime_identity']
  self.runtime_identity = "AUTHENTICATED_PRINCIPAL" if runtime_identity.nil? && !attributes.key?(:'runtimeIdentity') && !attributes.key?(:'runtime_identity') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#access_token_expiry_in_seconds ⇒ Integer

Access token expiry in seconds

Returns:

  • (Integer) 


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

def access_token_expiry_in_seconds
  @access_token_expiry_in_seconds
end

#built_in_roles ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsMcpServerBuiltInRole>

Built-in roles associated with the MCP Server.

Returns:



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

def built_in_roles
  @built_in_roles
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#custom_roles ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsMcpServerCustomRole>

Custom roles associated with the MCP Server.

Returns:



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

def custom_roles
  @custom_roles
end

#database_tools_connection_id ⇒ String

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

Returns:

  • (String) 


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

def database_tools_connection_id
  @database_tools_connection_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>>) 


103
104
105
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 103

def defined_tags
  @defined_tags
end

#description ⇒ String

A human-readable description of the Database Tools MCP server.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] A meaningful, human-readable label displayed to end users. Not required to be unique and can be changed after creation. Do not include confidential information.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#endpoints ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsMcpServerEndpoint>

Invoke endpoints for the MCP server.

Returns:



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

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


109
110
111
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 109

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


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

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) 


89
90
91
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 89

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



124
125
126
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 124

def locks
  @locks
end

#refresh_token_expiry_in_seconds ⇒ Integer

Refresh token expiry in seconds

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 77

def refresh_token_expiry_in_seconds
  @refresh_token_expiry_in_seconds
end

#related_resource ⇒ OCI::DatabaseTools::Models::DatabaseToolsMcpServerRelatedResource

This attribute is required.

Returns:



81
82
83
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 81

def related_resource
  @related_resource
end

#runtime_identity ⇒ String

[Required] Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the calleru2019s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the MCP Serveru2019s resource principal (RPST).

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 120

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


115
116
117
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 115

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) 


93
94
95
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 93

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) 


97
98
99
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 97

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The Database Tools MCP server type.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 127

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'database_tools_connection_id': :'databaseToolsConnectionId',
    'endpoints': :'endpoints',
    'built_in_roles': :'builtInRoles',
    'custom_roles': :'customRoles',
    'access_token_expiry_in_seconds': :'accessTokenExpiryInSeconds',
    'refresh_token_expiry_in_seconds': :'refreshTokenExpiryInSeconds',
    'related_resource': :'relatedResource',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'runtime_identity': :'runtimeIdentity',
    '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.



189
190
191
192
193
194
195
196
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 189

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

  return 'OCI::DatabaseTools::Models::DatabaseToolsMcpServerDefault' if type == 'DEFAULT'

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

.swagger_types ⇒ Object

Attribute type mapping.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 156

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'database_tools_connection_id': :'String',
    'endpoints': :'Array<OCI::DatabaseTools::Models::DatabaseToolsMcpServerEndpoint>',
    'built_in_roles': :'Array<OCI::DatabaseTools::Models::DatabaseToolsMcpServerBuiltInRole>',
    'custom_roles': :'Array<OCI::DatabaseTools::Models::DatabaseToolsMcpServerCustomRole>',
    'access_token_expiry_in_seconds': :'Integer',
    'refresh_token_expiry_in_seconds': :'Integer',
    'related_resource': :'OCI::DatabaseTools::Models::DatabaseToolsMcpServerRelatedResource',
    '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>>',
    'runtime_identity': :'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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 387

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

  self.class == other.class &&
    id == other.id &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    database_tools_connection_id == other.database_tools_connection_id &&
    endpoints == other.endpoints &&
    built_in_roles == other.built_in_roles &&
    custom_roles == other.custom_roles &&
    access_token_expiry_in_seconds == other.access_token_expiry_in_seconds &&
    refresh_token_expiry_in_seconds == other.refresh_token_expiry_in_seconds &&
    related_resource == other.related_resource &&
    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 &&
    runtime_identity == other.runtime_identity &&
    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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 437

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


417
418
419
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 417

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



426
427
428
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 426

def hash
  [id, type, compartment_id, display_name, description, database_tools_connection_id, endpoints, built_in_roles, custom_roles, access_token_expiry_in_seconds, refresh_token_expiry_in_seconds, related_resource, lifecycle_state, lifecycle_details, time_created, time_updated, defined_tags, freeform_tags, system_tags, runtime_identity, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



470
471
472
473
474
475
476
477
478
479
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 470

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



464
465
466
 
# File 'lib/oci/database_tools/models/database_tools_mcp_server.rb', line 464

def to_s
  to_hash.to_s
end