Class: OCI::DatabaseTools::Models::DatabaseToolsConnection

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

Overview

Provides connectivity details required to establish a connection to a database. 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

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_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'.freeze,
  TYPE_MYSQL = 'MYSQL'.freeze,
  TYPE_POSTGRESQL = 'POSTGRESQL'.freeze,
  TYPE_GENERIC_JDBC = 'GENERIC_JDBC'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RUNTIME_SUPPORT_ENUM = 
[
  RUNTIME_SUPPORT_SUPPORTED = 'SUPPORTED'.freeze,
  RUNTIME_SUPPORT_UNSUPPORTED = 'UNSUPPORTED'.freeze,
  RUNTIME_SUPPORT_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 = {}) ⇒ DatabaseToolsConnection

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_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

  • :type (String) —

    The value to assign to the #type property

  • :runtime_support (String) —

    The value to assign to the #runtime_support property

  • :runtime_endpoint (String) —

    The value to assign to the #runtime_endpoint property

  • :runtime_identity (String) —

    The value to assign to the #runtime_identity property



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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 196

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.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.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.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']

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

  self.runtime_support = attributes[:'runtimeSupport'] if attributes[:'runtimeSupport']

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

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

  self.runtime_endpoint = attributes[:'runtimeEndpoint'] if attributes[:'runtimeEndpoint']

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

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

  self.runtime_identity = attributes[:'runtimeIdentity'] if attributes[:'runtimeIdentity']

  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']
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 54

def compartment_id
  @compartment_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>>) 


76
77
78
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 76

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 50

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


82
83
84
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 82

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Database Tools connection.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 46

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) 


62
63
64
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 62

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Database Tools connection.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 58

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



92
93
94
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 92

def locks
  @locks
end

#runtime_endpoint ⇒ String

[Required] Specifies the Database Tools Runtime endpoint.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 104

def runtime_endpoint
  @runtime_endpoint
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 connectionu2019s resource principal (RPST).

Returns:

  • (String) 


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

def runtime_identity
  @runtime_identity
end

#runtime_support ⇒ String

[Required] Specifies whether this connection is supported by the Database Tools Runtime.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 100

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


88
89
90
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 88

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 66

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 70

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The Database Tools connection type.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 96

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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_connection.rb', line 112

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'locks': :'locks',
    'type': :'type',
    'runtime_support': :'runtimeSupport',
    'runtime_endpoint': :'runtimeEndpoint',
    'runtime_identity': :'runtimeIdentity'
    # 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.



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 162

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

  return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionOracleDatabase' if type == 'ORACLE_DATABASE'
  return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionPostgresql' if type == 'POSTGRESQL'
  return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionMySql' if type == 'MYSQL'
  return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionGenericJdbc' if type == 'GENERIC_JDBC'

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

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_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>',
    'type': :'String',
    'runtime_support': :'String',
    'runtime_endpoint': :'String',
    'runtime_identity': :'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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_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 &&
    type == other.type &&
    runtime_support == other.runtime_support &&
    runtime_endpoint == other.runtime_endpoint &&
    runtime_identity == other.runtime_identity
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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 384

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


364
365
366
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 364

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



373
374
375
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 373

def hash
  [id, display_name, compartment_id, lifecycle_state, lifecycle_details, time_created, time_updated, defined_tags, freeform_tags, system_tags, locks, type, runtime_support, runtime_endpoint, runtime_identity].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



417
418
419
420
421
422
423
424
425
426
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 417

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



411
412
413
 
# File 'lib/oci/database_tools/models/database_tools_connection.rb', line 411

def to_s
  to_hash.to_s
end