Class: OCI::GoldenGate::Models::UpdatePostgresqlConnectionDetails

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

Overview

The information to update a PostgreSQL Database Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #freeform_tags, #key_id, #nsg_ids, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdatePostgresqlConnectionDetails

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

  • :database_name (String) —

    The value to assign to the #database_name property

  • :host (String) —

    The value to assign to the #host property

  • :port (Integer) —

    The value to assign to the #port property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :additional_attributes (Array<OCI::GoldenGate::Models::NameValuePair>) —

    The value to assign to the #additional_attributes property

  • :security_protocol (String) —

    The value to assign to the #security_protocol property

  • :ssl_mode (String) —

    The value to assign to the #ssl_mode property

  • :ssl_ca (String) —

    The value to assign to the #ssl_ca property

  • :ssl_crl (String) —

    The value to assign to the #ssl_crl property

  • :ssl_cert (String) —

    The value to assign to the #ssl_cert property

  • :ssl_key (String) —

    The value to assign to the #ssl_key property

  • :private_ip (String) —

    The value to assign to the #private_ip property



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
235
236
237
238
239
240
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 169

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

  attributes['connectionType'] = 'POSTGRESQL'

  super(attributes)

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

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

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

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

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

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

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

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

  self.ssl_ca = attributes[:'sslCa'] if attributes[:'sslCa']

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

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

  self.ssl_crl = attributes[:'sslCrl'] if attributes[:'sslCrl']

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

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

  self.ssl_cert = attributes[:'sslCert'] if attributes[:'sslCert']

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

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

  self.ssl_key = attributes[:'sslKey'] if attributes[:'sslKey']

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

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

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



45
46
47
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 45

def additional_attributes
  @additional_attributes
end

#database_name ⇒ String

The name of the database.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 16

def database_name
  @database_name
end

#host ⇒ String

The name or address of a host.

Returns:

  • (String) 


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

def host
  @host
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.

Returns:

  • (String) 


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

def password
  @password
end

#port ⇒ Integer

The port of an endpoint usually specified for a connection.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 26

def port
  @port
end

#private_ip ⇒ String

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/update_postgresql_connection_details.rb', line 83

def private_ip
  @private_ip
end

#security_protocol ⇒ String

Security protocol for PostgreSQL.

Returns:

  • (String) 


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

def security_protocol
  @security_protocol
end

#ssl_ca ⇒ String

The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.

Returns:

  • (String) 


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

def ssl_ca
  @ssl_ca
end

#ssl_cert ⇒ String

The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt.

Returns:

  • (String) 


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

def ssl_cert
  @ssl_cert
end

#ssl_crl ⇒ String

The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 64

def ssl_crl
  @ssl_crl
end

#ssl_key ⇒ String

The base64 encoded private key of the PostgreSQL server. The supported file formats are .pem and .crt.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 74

def ssl_key
  @ssl_key
end

#ssl_mode ⇒ String

SSL modes for PostgreSQL.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 53

def ssl_mode
  @ssl_mode
end

#username ⇒ String

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) 


33
34
35
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 33

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 86

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',
    'database_name': :'databaseName',
    'host': :'host',
    'port': :'port',
    'username': :'username',
    'password': :'password',
    'additional_attributes': :'additionalAttributes',
    'security_protocol': :'securityProtocol',
    'ssl_mode': :'sslMode',
    'ssl_ca': :'sslCa',
    'ssl_crl': :'sslCrl',
    'ssl_cert': :'sslCert',
    'ssl_key': :'sslKey',
    'private_ip': :'privateIp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 115

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>',
    'database_name': :'String',
    'host': :'String',
    'port': :'Integer',
    'username': :'String',
    'password': :'String',
    'additional_attributes': :'Array<OCI::GoldenGate::Models::NameValuePair>',
    'security_protocol': :'String',
    'ssl_mode': :'String',
    'ssl_ca': :'String',
    'ssl_crl': :'String',
    'ssl_cert': :'String',
    'ssl_key': :'String',
    'private_ip': :'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



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

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 &&
    database_name == other.database_name &&
    host == other.host &&
    port == other.port &&
    username == other.username &&
    password == other.password &&
    additional_attributes == other.additional_attributes &&
    security_protocol == other.security_protocol &&
    ssl_mode == other.ssl_mode &&
    ssl_ca == other.ssl_ca &&
    ssl_crl == other.ssl_crl &&
    ssl_cert == other.ssl_cert &&
    ssl_key == other.ssl_key &&
    private_ip == other.private_ip
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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 299

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


279
280
281
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 279

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 288

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, database_name, host, port, username, password, additional_attributes, security_protocol, ssl_mode, ssl_ca, ssl_crl, ssl_cert, ssl_key, private_ip].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 332

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



326
327
328
 
# File 'lib/oci/golden_gate/models/update_postgresql_connection_details.rb', line 326

def to_s
  to_hash.to_s
end