Class: OCI::GoldenGate::Models::CreateOracleConnectionDetails

Inherits:
CreateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/create_oracle_connection_details.rb

Overview

The information about a new Oracle Database Connection.

Constant Summary

Constants inherited from CreateConnectionDetails

OCI::GoldenGate::Models::CreateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::CreateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateConnectionDetails

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateOracleConnectionDetails

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

  • :compartment_id (String) —

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

  • :locks (Array<OCI::GoldenGate::Models::AddResourceLockDetails>) —

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

  • :technology_type (String) —

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

  • :connection_string (String) —

    The value to assign to the #connection_string property

  • :authentication_mode (String) —

    The value to assign to the #authentication_mode property

  • :wallet (String) —

    The value to assign to the #wallet property

  • :wallet_secret_id (String) —

    The value to assign to the #wallet_secret_id property

  • :session_mode (String) —

    The value to assign to the #session_mode property

  • :private_ip (String) —

    The value to assign to the #private_ip property

  • :database_id (String) —

    The value to assign to the #database_id property



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

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

  attributes['connectionType'] = 'ORACLE'

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

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

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

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

  self.wallet_secret_id = attributes[:'walletSecretId'] if attributes[:'walletSecretId']

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

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

  self.session_mode = attributes[:'sessionMode'] if attributes[:'sessionMode']
  self.session_mode = "DIRECT" if session_mode.nil? && !attributes.key?(:'sessionMode') # rubocop:disable Style/StringLiterals

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

  self.session_mode = attributes[:'session_mode'] if attributes[:'session_mode']
  self.session_mode = "DIRECT" if session_mode.nil? && !attributes.key?(:'sessionMode') && !attributes.key?(:'session_mode') # rubocop:disable Style/StringLiterals

  self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp']

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

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

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

Instance Attribute Details

#authentication_mode ⇒ String

Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

Returns:

  • (String) 


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

def authentication_mode
  @authentication_mode
end

#connection_string ⇒ String

Connect descriptor or Easy Connect Naming method used to connect to a database.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 43

def connection_string
  @connection_string
end

#database_id ⇒ String

The OCID of the database being referenced.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 88

def database_id
  @database_id
end

#password ⇒ String

The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. 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/create_oracle_connection_details.rb', line 29

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 38

def password_secret_id
  @password_secret_id
end

#private_ip ⇒ String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 83

def private_ip
  @private_ip
end

#session_mode ⇒ String

The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 71

def session_mode
  @session_mode
end

#technology_type ⇒ String

[Required] The Oracle technology type.

Returns:

  • (String) 


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

def technology_type
  @technology_type
end

#username ⇒ String

[Required] The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 22

def username
  @username
end

#wallet ⇒ String

The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def wallet
  @wallet
end

#wallet_secret_id ⇒ String

The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.

Returns:

  • (String) 


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

def wallet_secret_id
  @wallet_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'locks': :'locks',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'technology_type': :'technologyType',
    'username': :'username',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'connection_string': :'connectionString',
    'authentication_mode': :'authenticationMode',
    'wallet': :'wallet',
    'wallet_secret_id': :'walletSecretId',
    'session_mode': :'sessionMode',
    'private_ip': :'privateIp',
    'database_id': :'databaseId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 123

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::GoldenGate::Models::AddResourceLockDetails>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'technology_type': :'String',
    'username': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'connection_string': :'String',
    'authentication_mode': :'String',
    'wallet': :'String',
    'wallet_secret_id': :'String',
    'session_mode': :'String',
    'private_ip': :'String',
    'database_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



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

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    locks == other.locks &&
    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 &&
    technology_type == other.technology_type &&
    username == other.username &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    connection_string == other.connection_string &&
    authentication_mode == other.authentication_mode &&
    wallet == other.wallet &&
    wallet_secret_id == other.wallet_secret_id &&
    session_mode == other.session_mode &&
    private_ip == other.private_ip &&
    database_id == other.database_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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 310

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


290
291
292
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 290

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



299
300
301
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 299

def hash
  [connection_type, display_name, description, compartment_id, freeform_tags, defined_tags, locks, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, technology_type, username, password, password_secret_id, connection_string, authentication_mode, wallet, wallet_secret_id, session_mode, private_ip, database_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 343

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



337
338
339
 
# File 'lib/oci/golden_gate/models/create_oracle_connection_details.rb', line 337

def to_s
  to_hash.to_s
end