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

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

Overview

Database Connection resource used for migrations.

Constant Summary collapse

DATABASE_TYPE_ENUM = 
[
  DATABASE_TYPE_MANUAL = 'MANUAL'.freeze,
  DATABASE_TYPE_AUTONOMOUS = 'AUTONOMOUS'.freeze,
  DATABASE_TYPE_USER_MANAGED_OCI = 'USER_MANAGED_OCI'.freeze,
  DATABASE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MANUAL_DATABASE_SUB_TYPE_ENUM = 
[
  MANUAL_DATABASE_SUB_TYPE_ORACLE = 'ORACLE'.freeze,
  MANUAL_DATABASE_SUB_TYPE_RDS_ORACLE = 'RDS_ORACLE'.freeze,
  MANUAL_DATABASE_SUB_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):



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

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

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

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

  self.manual_database_sub_type = attributes[:'manualDatabaseSubType'] if attributes[:'manualDatabaseSubType']
  self.manual_database_sub_type = "ORACLE" if manual_database_sub_type.nil? && !attributes.key?(:'manualDatabaseSubType') # rubocop:disable Style/StringLiterals

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

  self.manual_database_sub_type = attributes[:'manual_database_sub_type'] if attributes[:'manual_database_sub_type']
  self.manual_database_sub_type = "ORACLE" if manual_database_sub_type.nil? && !attributes.key?(:'manualDatabaseSubType') && !attributes.key?(:'manual_database_sub_type') # rubocop:disable Style/StringLiterals

  self.is_dedicated = attributes[:'isDedicated'] unless attributes[:'isDedicated'].nil?

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

  self.is_dedicated = attributes[:'is_dedicated'] unless attributes[:'is_dedicated'].nil?

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

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

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

  self.credentials_secret_id = attributes[:'credentialsSecretId'] if attributes[:'credentialsSecretId']

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

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

  self.certificate_tdn = attributes[:'certificateTdn'] if attributes[:'certificateTdn']

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

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

  self.ssh_details = attributes[:'sshDetails'] if attributes[:'sshDetails']

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

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

  self.admin_credentials = attributes[:'adminCredentials'] if attributes[:'adminCredentials']

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

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

  self.replication_credentials = attributes[:'replicationCredentials'] if attributes[:'replicationCredentials']

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

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

  self.private_endpoint = attributes[:'privateEndpoint'] if attributes[:'privateEndpoint']

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

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

  self.vault_details = attributes[:'vaultDetails'] if attributes[:'vaultDetails']

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

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

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

Instance Attribute Details

#admin_credentials ⇒ OCI::DatabaseMigration::Models::AdminCredentials

Returns:



89
90
91
 
# File 'lib/oci/database_migration/models/connection.rb', line 89

def admin_credentials
  @admin_credentials
end

#certificate_tdn ⇒ String

This name is the distinguished name used while creating the certificate on target database.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/database_migration/models/connection.rb', line 83

def certificate_tdn
  @certificate_tdn
end

#compartment_id ⇒ String

[Required] OCID of the compartment

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/database_migration/models/connection.rb', line 45

def compartment_id
  @compartment_id
end

#connect_descriptor ⇒ OCI::DatabaseMigration::Models::ConnectDescriptor

Returns:



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

def connect_descriptor
  @connect_descriptor
end

#credentials_secret_id ⇒ String

OCID of the Secret in the OCI vault containing the Database Connection credentials.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/database_migration/models/connection.rb', line 78

def credentials_secret_id
  @credentials_secret_id
end

#database_id ⇒ String

The OCID of the cloud database.

Returns:

  • (String) 


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

def database_id
  @database_id
end

#database_type ⇒ String

[Required] Database connection type.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_migration/models/connection.rb', line 50

def database_type
  @database_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>>) 


131
132
133
 
# File 'lib/oci/database_migration/models/connection.rb', line 131

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Database Connection display name identifier.

Returns:

  • (String) 


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

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


125
126
127
 
# File 'lib/oci/database_migration/models/connection.rb', line 125

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_migration/models/connection.rb', line 40

def id
  @id
end

#is_dedicated ⇒ BOOLEAN

True if the Autonomous Connection is dedicated. Not provided for Non-Autonomous Connections.

Returns:

  • (BOOLEAN) 


60
61
62
 
# File 'lib/oci/database_migration/models/connection.rb', line 60

def is_dedicated
  @is_dedicated
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Connection resource.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#manual_database_sub_type ⇒ String

Database manual connection subtype. This value can only be specified for manual connections.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database_migration/models/connection.rb', line 55

def manual_database_sub_type
  @manual_database_sub_type
end

#nsg_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


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

def nsg_ids
  @nsg_ids
end

#private_endpoint ⇒ OCI::DatabaseMigration::Models::PrivateEndpointDetails

Returns:



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

def private_endpoint
  @private_endpoint
end

#replication_credentials ⇒ OCI::DatabaseMigration::Models::AdminCredentials

Returns:



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

def replication_credentials
  @replication_credentials
end

#ssh_details ⇒ OCI::DatabaseMigration::Models::SshDetails

Returns:



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

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the Connection resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time of the last Connection resource details update. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#vault_details ⇒ OCI::DatabaseMigration::Models::VaultDetails

Returns:



98
99
100
 
# File 'lib/oci/database_migration/models/connection.rb', line 98

def vault_details
  @vault_details
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'database_type': :'databaseType',
    'manual_database_sub_type': :'manualDatabaseSubType',
    'is_dedicated': :'isDedicated',
    'display_name': :'displayName',
    'database_id': :'databaseId',
    'connect_descriptor': :'connectDescriptor',
    'credentials_secret_id': :'credentialsSecretId',
    'certificate_tdn': :'certificateTdn',
    'ssh_details': :'sshDetails',
    'admin_credentials': :'adminCredentials',
    'replication_credentials': :'replicationCredentials',
    'private_endpoint': :'privateEndpoint',
    'vault_details': :'vaultDetails',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'nsg_ids': :'nsgIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'database_type': :'String',
    'manual_database_sub_type': :'String',
    'is_dedicated': :'BOOLEAN',
    'display_name': :'String',
    'database_id': :'String',
    'connect_descriptor': :'OCI::DatabaseMigration::Models::ConnectDescriptor',
    'credentials_secret_id': :'String',
    'certificate_tdn': :'String',
    'ssh_details': :'OCI::DatabaseMigration::Models::SshDetails',
    'admin_credentials': :'OCI::DatabaseMigration::Models::AdminCredentials',
    'replication_credentials': :'OCI::DatabaseMigration::Models::AdminCredentials',
    'private_endpoint': :'OCI::DatabaseMigration::Models::PrivateEndpointDetails',
    'vault_details': :'OCI::DatabaseMigration::Models::VaultDetails',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'nsg_ids': :'Array<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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/oci/database_migration/models/connection.rb', line 424

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    database_type == other.database_type &&
    manual_database_sub_type == other.manual_database_sub_type &&
    is_dedicated == other.is_dedicated &&
    display_name == other.display_name &&
    database_id == other.database_id &&
    connect_descriptor == other.connect_descriptor &&
    credentials_secret_id == other.credentials_secret_id &&
    certificate_tdn == other.certificate_tdn &&
    ssh_details == other.ssh_details &&
    admin_credentials == other.admin_credentials &&
    replication_credentials == other.replication_credentials &&
    private_endpoint == other.private_endpoint &&
    vault_details == other.vault_details &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    nsg_ids == other.nsg_ids
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



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/oci/database_migration/models/connection.rb', line 476

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


456
457
458
 
# File 'lib/oci/database_migration/models/connection.rb', line 456

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



465
466
467
 
# File 'lib/oci/database_migration/models/connection.rb', line 465

def hash
  [id, compartment_id, database_type, manual_database_sub_type, is_dedicated, display_name, database_id, connect_descriptor, credentials_secret_id, certificate_tdn, ssh_details, admin_credentials, replication_credentials, private_endpoint, vault_details, lifecycle_state, lifecycle_details, time_created, time_updated, freeform_tags, defined_tags, system_tags, nsg_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



509
510
511
512
513
514
515
516
517
518
 
# File 'lib/oci/database_migration/models/connection.rb', line 509

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



503
504
505
 
# File 'lib/oci/database_migration/models/connection.rb', line 503

def to_s
  to_hash.to_s
end