Class: OCI::GoldenGate::Models::UpdateMongoDbConnectionDetails

Inherits:
UpdateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/update_mongo_db_connection_details.rb

Overview

The information to update a MongoDB Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::UpdateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #key_id, #nsg_ids, #routing_method, #security_attributes, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateMongoDbConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

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

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

    The value to assign to the #key_id proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :routing_method (String) —

    The value to assign to the #routing_method proprety

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids proprety

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

    The value to assign to the #security_attributes proprety

  • :connection_string (String) —

    The value to assign to the #connection_string property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :database_id (String) —

    The value to assign to the #database_id property

  • :security_protocol (String) —

    The value to assign to the #security_protocol property

  • :tls_ca_file (String) —

    The value to assign to the #tls_ca_file property

  • :tls_certificate_key_file (String) —

    The value to assign to the #tls_certificate_key_file property

  • :tls_certificate_key_file_secret_id (String) —

    The value to assign to the #tls_certificate_key_file_secret_id property

  • :tls_certificate_key_file_password (String) —

    The value to assign to the #tls_certificate_key_file_password property

  • :tls_certificate_key_file_password_secret_id (String) —

    The value to assign to the #tls_certificate_key_file_password_secret_id property



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 167

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

  attributes['connectionType'] = 'MONGODB'

  super(attributes)

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

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

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

  self.password_secret_id = attributes[:'passwordSecretId'] if attributes[:'passwordSecretId']

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

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

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

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

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

  self.tls_ca_file = attributes[:'tlsCaFile'] if attributes[:'tlsCaFile']

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

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

  self.tls_certificate_key_file = attributes[:'tlsCertificateKeyFile'] if attributes[:'tlsCertificateKeyFile']

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

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

  self.tls_certificate_key_file_secret_id = attributes[:'tlsCertificateKeyFileSecretId'] if attributes[:'tlsCertificateKeyFileSecretId']

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

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

  self.tls_certificate_key_file_password = attributes[:'tlsCertificateKeyFilePassword'] if attributes[:'tlsCertificateKeyFilePassword']

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

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

  self.tls_certificate_key_file_password_secret_id = attributes[:'tlsCertificateKeyFilePasswordSecretId'] if attributes[:'tlsCertificateKeyFilePasswordSecretId']

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

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

Instance Attribute Details

#connection_string ⇒ String

MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 17

def connection_string
  @connection_string
end

#database_id ⇒ String

The OCID of the Oracle Autonomous Json Database.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 40

def database_id
  @database_id
end

#password ⇒ String

The password Oracle GoldenGate uses to connect the associated database. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 29

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret that stores the password Oracle GoldenGate uses to connect the associated database. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 35

def password_secret_id
  @password_secret_id
end

#security_protocol ⇒ String

Security Type for MongoDB.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 44

def security_protocol
  @security_protocol
end

#tls_ca_file ⇒ String

Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 50

def tls_ca_file
  @tls_ca_file
end

#tls_certificate_key_file ⇒ String

Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 56

def tls_certificate_key_file
  @tls_certificate_key_file
end

#tls_certificate_key_file_password ⇒ String

Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 69

def tls_certificate_key_file_password
  @tls_certificate_key_file_password
end

#tls_certificate_key_file_password_secret_id ⇒ String

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 75

def tls_certificate_key_file_password_secret_id
  @tls_certificate_key_file_password_secret_id
end

#tls_certificate_key_file_secret_id ⇒ String

The OCID of the Secret that stores the certificate key file of the mtls connection. - The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 63

def tls_certificate_key_file_secret_id
  @tls_certificate_key_file_secret_id
end

#username ⇒ String

The username Oracle GoldenGate uses to connect to the database. This username must already exist and be available by the database to be connected to.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 23

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'security_attributes': :'securityAttributes',
    'connection_string': :'connectionString',
    'username': :'username',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'database_id': :'databaseId',
    'security_protocol': :'securityProtocol',
    'tls_ca_file': :'tlsCaFile',
    'tls_certificate_key_file': :'tlsCertificateKeyFile',
    'tls_certificate_key_file_secret_id': :'tlsCertificateKeyFileSecretId',
    'tls_certificate_key_file_password': :'tlsCertificateKeyFilePassword',
    'tls_certificate_key_file_password_secret_id': :'tlsCertificateKeyFilePasswordSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'connection_string': :'String',
    'username': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'database_id': :'String',
    'security_protocol': :'String',
    'tls_ca_file': :'String',
    'tls_certificate_key_file': :'String',
    'tls_certificate_key_file_secret_id': :'String',
    'tls_certificate_key_file_password': :'String',
    'tls_certificate_key_file_password_secret_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



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
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 243

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    security_attributes == other.security_attributes &&
    connection_string == other.connection_string &&
    username == other.username &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    database_id == other.database_id &&
    security_protocol == other.security_protocol &&
    tls_ca_file == other.tls_ca_file &&
    tls_certificate_key_file == other.tls_certificate_key_file &&
    tls_certificate_key_file_secret_id == other.tls_certificate_key_file_secret_id &&
    tls_certificate_key_file_password == other.tls_certificate_key_file_password &&
    tls_certificate_key_file_password_secret_id == other.tls_certificate_key_file_password_secret_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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 295

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


275
276
277
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 284

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, security_attributes, connection_string, username, password, password_secret_id, database_id, security_protocol, tls_ca_file, tls_certificate_key_file, tls_certificate_key_file_secret_id, tls_certificate_key_file_password, tls_certificate_key_file_password_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 328

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



322
323
324
 
# File 'lib/oci/golden_gate/models/update_mongo_db_connection_details.rb', line 322

def to_s
  to_hash.to_s
end