Class: OCI::GoldenGate::Models::MongoDbConnectionSummary

Inherits:
ConnectionSummary show all
Defined in:
lib/oci/golden_gate/models/mongo_db_connection_summary.rb

Overview

Summary of the MongoDB Connection.

Constant Summary

Constants inherited from ConnectionSummary

ConnectionSummary::CONNECTION_TYPE_ENUM, ConnectionSummary::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConnectionSummary

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #locks, #nsg_ids, #routing_method, #subnet_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ConnectionSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ MongoDbConnectionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



162
163
164
165
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
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 162

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

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


21
22
23
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 21

def connection_string
  @connection_string
end

#database_id ⇒ String

The OCID of the Oracle Autonomous Json Database.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 32

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


42
43
44
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 42

def password_secret_id
  @password_secret_id
end

#security_protocol ⇒ String

Security Type for MongoDB.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 36

def security_protocol
  @security_protocol
end

#technology_type ⇒ String

[Required] The MongoDB technology type.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 15

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


55
56
57
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 55

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) 


49
50
51
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 49

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) 


27
28
29
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 27

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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/golden_gate/models/mongo_db_connection_summary.rb', line 58

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',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'locks': :'locks',
    'does_use_secret_ids': :'doesUseSecretIds',
    'technology_type': :'technologyType',
    'connection_string': :'connectionString',
    'username': :'username',
    'database_id': :'databaseId',
    'security_protocol': :'securityProtocol',
    'password_secret_id': :'passwordSecretId',
    'tls_certificate_key_file_secret_id': :'tlsCertificateKeyFileSecretId',
    'tls_certificate_key_file_password_secret_id': :'tlsCertificateKeyFilePasswordSecretId'
    # 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
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.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',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'does_use_secret_ids': :'BOOLEAN',
    'technology_type': :'String',
    'connection_string': :'String',
    'username': :'String',
    'database_id': :'String',
    'security_protocol': :'String',
    'password_secret_id': :'String',
    'tls_certificate_key_file_secret_id': :'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



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

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 &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    locks == other.locks &&
    does_use_secret_ids == other.does_use_secret_ids &&
    technology_type == other.technology_type &&
    connection_string == other.connection_string &&
    username == other.username &&
    database_id == other.database_id &&
    security_protocol == other.security_protocol &&
    password_secret_id == other.password_secret_id &&
    tls_certificate_key_file_secret_id == other.tls_certificate_key_file_secret_id &&
    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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 281

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


261
262
263
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 261

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 270

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, ingress_ips, nsg_ids, subnet_id, routing_method, locks, does_use_secret_ids, technology_type, connection_string, username, database_id, security_protocol, password_secret_id, tls_certificate_key_file_secret_id, 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



314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 314

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



308
309
310
 
# File 'lib/oci/golden_gate/models/mongo_db_connection_summary.rb', line 308

def to_s
  to_hash.to_s
end