Class: OCI::DatabaseMigration::Models::OracleConnection

Inherits:
Connection
  • Object
show all
Defined in:
lib/oci/database_migration/models/oracle_connection.rb

Overview

Represents the metadata of an Oracle Database Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM = 
[
  TECHNOLOGY_TYPE_AMAZON_RDS_ORACLE = 'AMAZON_RDS_ORACLE'.freeze,
  TECHNOLOGY_TYPE_OCI_AUTONOMOUS_DATABASE = 'OCI_AUTONOMOUS_DATABASE'.freeze,
  TECHNOLOGY_TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'.freeze,
  TECHNOLOGY_TYPE_ORACLE_EXADATA = 'ORACLE_EXADATA'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Connection

Connection::CONNECTION_TYPE_ENUM, Connection::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #nsg_ids, #password, #private_endpoint_id, #replication_password, #replication_username, #secret_id, #subnet_id, #system_tags, #time_created, #time_updated, #username, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OracleConnection

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 proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

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

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

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

    The value to assign to the #system_tags proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

    The value to assign to the #key_id proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :ingress_ips (Array<OCI::DatabaseMigration::Models::IngressIpDetails>) —

    The value to assign to the #ingress_ips proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :username (String) —

    The value to assign to the #username proprety

  • :password (String) —

    The value to assign to the #password proprety

  • :replication_username (String) —

    The value to assign to the #replication_username proprety

  • :replication_password (String) —

    The value to assign to the #replication_password proprety

  • :secret_id (String) —

    The value to assign to the #secret_id proprety

  • :private_endpoint_id (String) —

    The value to assign to the #private_endpoint_id proprety

  • :technology_type (String) —

    The value to assign to the #technology_type property

  • :connection_string (String) —

    The value to assign to the #connection_string property

  • :database_id (String) —

    The value to assign to the #database_id property

  • :ssh_host (String) —

    The value to assign to the #ssh_host property

  • :ssh_key (String) —

    The value to assign to the #ssh_key property

  • :ssh_user (String) —

    The value to assign to the #ssh_user property

  • :ssh_sudo_location (String) —

    The value to assign to the #ssh_sudo_location property



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
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
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 166

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

  attributes['connectionType'] = 'ORACLE'

  super(attributes)

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

  self.technology_type = attributes[:'technologyType'] if attributes[:'technologyType']

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

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

  self.connection_string = attributes[:'connectionString'] if attributes[:'connectionString']

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

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

  self.database_id = attributes[:'databaseId'] if attributes[:'databaseId']

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

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

  self.ssh_host = attributes[:'sshHost'] if attributes[:'sshHost']

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

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

  self.ssh_key = attributes[:'sshKey'] if attributes[:'sshKey']

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

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

  self.ssh_user = attributes[:'sshUser'] if attributes[:'sshUser']

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

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

  self.ssh_sudo_location = attributes[:'sshSudoLocation'] if attributes[:'sshSudoLocation']

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

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

Instance Attribute Details

#connection_string ⇒ String

Connect descriptor or Easy Connect Naming method used to connect to a database.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 28

def connection_string
  @connection_string
end

#database_id ⇒ String

The OCID of the database being referenced.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 33

def database_id
  @database_id
end

#ssh_host ⇒ String

Name of the host the SSH key is valid for.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 38

def ssh_host
  @ssh_host
end

#ssh_key ⇒ String

Private SSH key string.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 43

def ssh_key
  @ssh_key
end

#ssh_sudo_location ⇒ String

Sudo location

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 53

def ssh_sudo_location
  @ssh_sudo_location
end

#ssh_user ⇒ String

The username (credential) used when creating or updating this resource.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 48

def ssh_user
  @ssh_user
end

#technology_type ⇒ String

[Required] The Oracle technology type.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 23

def technology_type
  @technology_type
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'subnet_id': :'subnetId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'username': :'username',
    'password': :'password',
    'replication_username': :'replicationUsername',
    'replication_password': :'replicationPassword',
    'secret_id': :'secretId',
    'private_endpoint_id': :'privateEndpointId',
    'technology_type': :'technologyType',
    'connection_string': :'connectionString',
    'database_id': :'databaseId',
    'ssh_host': :'sshHost',
    'ssh_key': :'sshKey',
    'ssh_user': :'sshUser',
    'ssh_sudo_location': :'sshSudoLocation'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 94

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'vault_id': :'String',
    'key_id': :'String',
    'subnet_id': :'String',
    'ingress_ips': :'Array<OCI::DatabaseMigration::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'username': :'String',
    'password': :'String',
    'replication_username': :'String',
    'replication_password': :'String',
    'secret_id': :'String',
    'private_endpoint_id': :'String',
    'technology_type': :'String',
    'connection_string': :'String',
    'database_id': :'String',
    'ssh_host': :'String',
    'ssh_key': :'String',
    'ssh_user': :'String',
    'ssh_sudo_location': :'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



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
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 239

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    subnet_id == other.subnet_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    username == other.username &&
    password == other.password &&
    replication_username == other.replication_username &&
    replication_password == other.replication_password &&
    secret_id == other.secret_id &&
    private_endpoint_id == other.private_endpoint_id &&
    technology_type == other.technology_type &&
    connection_string == other.connection_string &&
    database_id == other.database_id &&
    ssh_host == other.ssh_host &&
    ssh_key == other.ssh_key &&
    ssh_user == other.ssh_user &&
    ssh_sudo_location == other.ssh_sudo_location
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 298

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


278
279
280
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 278

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



287
288
289
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 287

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, vault_id, key_id, subnet_id, ingress_ips, nsg_ids, username, password, replication_username, replication_password, secret_id, private_endpoint_id, technology_type, connection_string, database_id, ssh_host, ssh_key, ssh_user, ssh_sudo_location].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 331

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



325
326
327
 
# File 'lib/oci/database_migration/models/oracle_connection.rb', line 325

def to_s
  to_hash.to_s
end