Class: OCI::DatabaseMigration::Models::CreateConnectionDetails

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

Overview

Details to create a Database Connection resource.

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
].freeze
MANUAL_DATABASE_SUB_TYPE_ENUM = 
[
  MANUAL_DATABASE_SUB_TYPE_ORACLE = 'ORACLE'.freeze,
  MANUAL_DATABASE_SUB_TYPE_RDS_ORACLE = 'RDS_ORACLE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
280
281
282
283
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 174

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

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

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

  self.tls_keystore = attributes[:'tlsKeystore'] if attributes[:'tlsKeystore']

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

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

  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.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.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::CreateAdminCredentials

This attribute is required.

Returns:



72
73
74
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 72

def admin_credentials
  @admin_credentials
end

#certificate_tdn ⇒ String

This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

Returns:

  • (String) 


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

def certificate_tdn
  @certificate_tdn
end

#compartment_id ⇒ String

[Required] OCID of the compartment

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 26

def compartment_id
  @compartment_id
end

#connect_descriptor ⇒ OCI::DatabaseMigration::Models::CreateConnectDescriptor

Returns:



49
50
51
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 49

def connect_descriptor
  @connect_descriptor
end

#database_id ⇒ String

The OCID of the cloud database. Required if the database connection type is Autonomous.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 46

def database_id
  @database_id
end

#database_type ⇒ String

[Required] Database connection type.

Returns:

  • (String) 


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

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


94
95
96
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 94

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Database Connection display name identifier.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 31

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


88
89
90
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 88

def freeform_tags
  @freeform_tags
end

#manual_database_sub_type ⇒ String

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

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 41

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


99
100
101
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 99

def nsg_ids
  @nsg_ids
end

#private_endpoint ⇒ OCI::DatabaseMigration::Models::CreatePrivateEndpoint

Returns:



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

def private_endpoint
  @private_endpoint
end

#replication_credentials ⇒ OCI::DatabaseMigration::Models::CreateAdminCredentials

Returns:



75
76
77
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 75

def replication_credentials
  @replication_credentials
end

#ssh_details ⇒ OCI::DatabaseMigration::Models::CreateSshDetails

Returns:



68
69
70
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 68

def ssh_details
  @ssh_details
end

#tls_keystore ⇒ String

keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

Returns:

  • (String) 


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

def tls_keystore
  @tls_keystore
end

#tls_wallet ⇒ String

cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

Returns:

  • (String) 


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

def tls_wallet
  @tls_wallet
end

#vault_details ⇒ OCI::DatabaseMigration::Models::CreateVaultDetails

This attribute is required.

Returns:



82
83
84
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 82

def vault_details
  @vault_details
end

Class Method Details

.attribute_map ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 102

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'database_type': :'databaseType',
    'manual_database_sub_type': :'manualDatabaseSubType',
    'database_id': :'databaseId',
    'connect_descriptor': :'connectDescriptor',
    'certificate_tdn': :'certificateTdn',
    'tls_wallet': :'tlsWallet',
    'tls_keystore': :'tlsKeystore',
    'ssh_details': :'sshDetails',
    'admin_credentials': :'adminCredentials',
    'replication_credentials': :'replicationCredentials',
    'private_endpoint': :'privateEndpoint',
    'vault_details': :'vaultDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'nsg_ids': :'nsgIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 127

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'database_type': :'String',
    'manual_database_sub_type': :'String',
    'database_id': :'String',
    'connect_descriptor': :'OCI::DatabaseMigration::Models::CreateConnectDescriptor',
    'certificate_tdn': :'String',
    'tls_wallet': :'String',
    'tls_keystore': :'String',
    'ssh_details': :'OCI::DatabaseMigration::Models::CreateSshDetails',
    'admin_credentials': :'OCI::DatabaseMigration::Models::CreateAdminCredentials',
    'replication_credentials': :'OCI::DatabaseMigration::Models::CreateAdminCredentials',
    'private_endpoint': :'OCI::DatabaseMigration::Models::CreatePrivateEndpoint',
    'vault_details': :'OCI::DatabaseMigration::Models::CreateVaultDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 308

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    database_type == other.database_type &&
    manual_database_sub_type == other.manual_database_sub_type &&
    database_id == other.database_id &&
    connect_descriptor == other.connect_descriptor &&
    certificate_tdn == other.certificate_tdn &&
    tls_wallet == other.tls_wallet &&
    tls_keystore == other.tls_keystore &&
    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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



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/create_connection_details.rb', line 354

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


334
335
336
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 334

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



343
344
345
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 343

def hash
  [compartment_id, display_name, database_type, manual_database_sub_type, database_id, connect_descriptor, certificate_tdn, tls_wallet, tls_keystore, ssh_details, admin_credentials, replication_credentials, private_endpoint, vault_details, freeform_tags, defined_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



387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 387

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



381
382
383
 
# File 'lib/oci/database_migration/models/create_connection_details.rb', line 381

def to_s
  to_hash.to_s
end