Class: OCI::GoldenGate::Models::Db2Connection

Inherits:
Connection
  • Object
show all
Defined in:
lib/oci/golden_gate/models/db2_connection.rb

Overview

Represents the metadata of a DB2 Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM = 
[
  TECHNOLOGY_TYPE_DB2_I = 'DB2_I'.freeze,
  TECHNOLOGY_TYPE_DB2_ZOS = 'DB2_ZOS'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SECURITY_PROTOCOL_ENUM = 
[
  SECURITY_PROTOCOL_PLAIN = 'PLAIN'.freeze,
  SECURITY_PROTOCOL_TLS = 'TLS'.freeze,
  SECURITY_PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Connection

Connection::CONNECTION_TYPE_ENUM, Connection::LIFECYCLE_STATE_ENUM, Connection::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#cluster_placement_group_id, #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, #security_attributes, #subnet_id, #subscription_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ Db2Connection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

  attributes['connectionType'] = 'DB2'

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

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

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

  self.database_name = attributes[:'databaseName'] if attributes[:'databaseName']

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

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

  self.additional_attributes = attributes[:'additionalAttributes'] if attributes[:'additionalAttributes']

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

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

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

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

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

  self.ssl_client_keystash_secret_id = attributes[:'sslClientKeystashSecretId'] if attributes[:'sslClientKeystashSecretId']

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

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

  self.ssl_server_certificate = attributes[:'sslServerCertificate'] if attributes[:'sslServerCertificate']

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

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

Instance Attribute Details

#additional_attributes ⇒ Array<OCI::GoldenGate::Models::NameValuePair>

An array of name-value pair attribute entries. Used as additional parameters in connection string.

Returns:



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

def additional_attributes
  @additional_attributes
end

#database_name ⇒ String

[Required] The name of the database.

Returns:

  • (String) 


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

def database_name
  @database_name
end

#host ⇒ String

[Required] The name or address of a host.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 39

def host
  @host
end

#password_secret_id ⇒ String

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

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 66

def password_secret_id
  @password_secret_id
end

#port ⇒ Integer

[Required] The port of an endpoint usually specified for a connection.

Returns:

  • (Integer) 


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

def port
  @port
end

#security_protocol ⇒ String

[Required] Security Protocol for the DB2 database.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 59

def security_protocol
  @security_protocol
end

#ssl_client_keystash_secret_id ⇒ String

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, 'sslClientKeystash' field must not be provided.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 84

def ssl_client_keystash_secret_id
  @ssl_client_keystash_secret_id
end

#ssl_client_keystoredb_secret_id ⇒ String

The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, 'sslClientKeystoredb' field must not be provided.

Returns:

  • (String) 


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

def ssl_client_keystoredb_secret_id
  @ssl_client_keystoredb_secret_id
end

#ssl_server_certificate ⇒ String

The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 90

def ssl_server_certificate
  @ssl_server_certificate
end

#technology_type ⇒ String

[Required] The DB2 technology type.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 28

def technology_type
  @technology_type
end

#username ⇒ String

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

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 34

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



93
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
128
129
130
131
132
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 93

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',
    'locks': :'locks',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'subscription_id': :'subscriptionId',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'security_attributes': :'securityAttributes',
    'technology_type': :'technologyType',
    'username': :'username',
    'host': :'host',
    'port': :'port',
    'database_name': :'databaseName',
    'additional_attributes': :'additionalAttributes',
    'security_protocol': :'securityProtocol',
    'password_secret_id': :'passwordSecretId',
    'ssl_client_keystoredb_secret_id': :'sslClientKeystoredbSecretId',
    'ssl_client_keystash_secret_id': :'sslClientKeystashSecretId',
    'ssl_server_certificate': :'sslServerCertificate'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
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
173
174
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 135

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',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'subscription_id': :'String',
    'cluster_placement_group_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'technology_type': :'String',
    'username': :'String',
    'host': :'String',
    'port': :'Integer',
    'database_name': :'String',
    'additional_attributes': :'Array<OCI::GoldenGate::Models::NameValuePair>',
    'security_protocol': :'String',
    'password_secret_id': :'String',
    'ssl_client_keystoredb_secret_id': :'String',
    'ssl_client_keystash_secret_id': :'String',
    'ssl_server_certificate': :'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



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

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 &&
    locks == other.locks &&
    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 &&
    does_use_secret_ids == other.does_use_secret_ids &&
    subscription_id == other.subscription_id &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    security_attributes == other.security_attributes &&
    technology_type == other.technology_type &&
    username == other.username &&
    host == other.host &&
    port == other.port &&
    database_name == other.database_name &&
    additional_attributes == other.additional_attributes &&
    security_protocol == other.security_protocol &&
    password_secret_id == other.password_secret_id &&
    ssl_client_keystoredb_secret_id == other.ssl_client_keystoredb_secret_id &&
    ssl_client_keystash_secret_id == other.ssl_client_keystash_secret_id &&
    ssl_server_certificate == other.ssl_server_certificate
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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 376

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


356
357
358
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 356

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



365
366
367
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 365

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, locks, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, does_use_secret_ids, subscription_id, cluster_placement_group_id, security_attributes, technology_type, username, host, port, database_name, additional_attributes, security_protocol, password_secret_id, ssl_client_keystoredb_secret_id, ssl_client_keystash_secret_id, ssl_server_certificate].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



409
410
411
412
413
414
415
416
417
418
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 409

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



403
404
405
 
# File 'lib/oci/golden_gate/models/db2_connection.rb', line 403

def to_s
  to_hash.to_s
end