Class: OCI::DatabaseMigration::Models::Connection

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

Overview

Represents the common details required for creating a new connection. 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

MysqlConnection, OracleConnection

Constant Summary collapse

CONNECTION_TYPE_ENUM = 
[
  CONNECTION_TYPE_MYSQL = 'MYSQL'.freeze,
  CONNECTION_TYPE_ORACLE = 'ORACLE'.freeze,
  CONNECTION_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_INACTIVE = 'INACTIVE'.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 = {}) ⇒ Connection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :connection_type (String) —

    The value to assign to the #connection_type property

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

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

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

  • :vault_id (String) —

    The value to assign to the #vault_id property

  • :key_id (String) —

    The value to assign to the #key_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

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

    The value to assign to the #ingress_ips property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :replication_username (String) —

    The value to assign to the #replication_username property

  • :replication_password (String) —

    The value to assign to the #replication_password property

  • :secret_id (String) —

    The value to assign to the #secret_id property

  • :private_endpoint_id (String) —

    The value to assign to the #private_endpoint_id property



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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/database_migration/models/connection.rb', line 250

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

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

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

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

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

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

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

  self.key_id = attributes[:'keyId'] if attributes[:'keyId']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.ingress_ips = attributes[:'ingressIps'] if attributes[:'ingressIps']

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

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

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

  self.replication_username = attributes[:'replicationUsername'] if attributes[:'replicationUsername']

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

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

  self.replication_password = attributes[:'replicationPassword'] if attributes[:'replicationPassword']

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

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

  self.secret_id = attributes[:'secretId'] if attributes[:'secretId']

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

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

  self.private_endpoint_id = attributes[:'privateEndpointId'] if attributes[:'privateEndpointId']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database_migration/models/connection.rb', line 52

def compartment_id
  @compartment_id
end

#connection_type ⇒ String

[Required] Defines the type of connection. For example, ORACLE.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_migration/models/connection.rb', line 32

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


64
65
66
 
# File 'lib/oci/database_migration/models/connection.rb', line 64

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


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

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


42
43
44
 
# File 'lib/oci/database_migration/models/connection.rb', line 42

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: "Finance"

Returns:

  • (Hash<String, String>) 


58
59
60
 
# File 'lib/oci/database_migration/models/connection.rb', line 58

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the connection being referenced.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_migration/models/connection.rb', line 36

def id
  @id
end

#ingress_ips ⇒ Array<OCI::DatabaseMigration::Models::IngressIpDetails>

List of ingress IP addresses from where to connect to this connection's privateIp.

Returns:



108
109
110
 
# File 'lib/oci/database_migration/models/connection.rb', line 108

def ingress_ips
  @ingress_ips
end

#key_id ⇒ String

The OCID of the key used in cryptographic operations.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/database_migration/models/connection.rb', line 100

def key_id
  @key_id
end

#lifecycle_details ⇒ String

The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database_migration/models/connection.rb', line 80

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The Connection's current lifecycle state.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/database_migration/models/connection.rb', line 74

def lifecycle_state
  @lifecycle_state
end

#nsg_ids ⇒ Array<String>

An array of Network Security Group OCIDs used to define network access for Connections.

Returns:

  • (Array<String>) 


113
114
115
 
# File 'lib/oci/database_migration/models/connection.rb', line 113

def nsg_ids
  @nsg_ids
end

#password ⇒ String

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

Returns:

  • (String) 


123
124
125
 
# File 'lib/oci/database_migration/models/connection.rb', line 123

def password
  @password
end

#private_endpoint_id ⇒ String

The OCID of the resource being referenced.

Returns:

  • (String) 


141
142
143
 
# File 'lib/oci/database_migration/models/connection.rb', line 141

def private_endpoint_id
  @private_endpoint_id
end

#replication_password ⇒ String

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

Returns:

  • (String) 


133
134
135
 
# File 'lib/oci/database_migration/models/connection.rb', line 133

def replication_password
  @replication_password
end

#replication_username ⇒ String

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

Returns:

  • (String) 


128
129
130
 
# File 'lib/oci/database_migration/models/connection.rb', line 128

def replication_username
  @replication_username
end

#secret_id ⇒ String

The OCID of the resource being referenced.

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/database_migration/models/connection.rb', line 137

def secret_id
  @secret_id
end

#subnet_id ⇒ String

OCI resource ID.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/database_migration/models/connection.rb', line 104

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


70
71
72
 
# File 'lib/oci/database_migration/models/connection.rb', line 70

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/database_migration/models/connection.rb', line 86

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/database_migration/models/connection.rb', line 92

def time_updated
  @time_updated
end

#username ⇒ String

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

Returns:

  • (String) 


118
119
120
 
# File 'lib/oci/database_migration/models/connection.rb', line 118

def username
  @username
end

#vault_id ⇒ String

OCI resource ID.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/database_migration/models/connection.rb', line 96

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



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
170
171
172
 
# File 'lib/oci/database_migration/models/connection.rb', line 144

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



210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/database_migration/models/connection.rb', line 210

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

  return 'OCI::DatabaseMigration::Models::MysqlConnection' if type == 'MYSQL'
  return 'OCI::DatabaseMigration::Models::OracleConnection' if type == 'ORACLE'

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/oci/database_migration/models/connection.rb', line 412

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



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/oci/database_migration/models/connection.rb', line 464

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


444
445
446
 
# File 'lib/oci/database_migration/models/connection.rb', line 444

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



453
454
455
 
# File 'lib/oci/database_migration/models/connection.rb', line 453

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



497
498
499
500
501
502
503
504
505
506
 
# File 'lib/oci/database_migration/models/connection.rb', line 497

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



491
492
493
 
# File 'lib/oci/database_migration/models/connection.rb', line 491

def to_s
  to_hash.to_s
end