Class: OCI::GoldenGate::Models::UpdateMicrosoftSqlserverConnectionDetails

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

Overview

The information to update a Microsoft SQL Server 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 = {}) ⇒ UpdateMicrosoftSqlserverConnectionDetails

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_ca (String) —

    The value to assign to the #ssl_ca property

  • :should_validate_server_certificate (BOOLEAN) —

    The value to assign to the #should_validate_server_certificate property

  • :private_ip (String) —

    The value to assign to the #private_ip property



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 144

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

  attributes['connectionType'] = 'MICROSOFT_SQLSERVER'

  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_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.should_validate_server_certificate = attributes[:'shouldValidateServerCertificate'] unless attributes[:'shouldValidateServerCertificate'].nil?

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

  self.should_validate_server_certificate = attributes[:'should_validate_server_certificate'] unless attributes[:'should_validate_server_certificate'].nil?

  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:



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

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_microsoft_sqlserver_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_microsoft_sqlserver_connection_details.rb', line 21

def host
  @host
end

#password ⇒ String

The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 37

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_microsoft_sqlserver_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) 


67
68
69
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 67

def private_ip
  @private_ip
end

#security_protocol ⇒ String

Security Type for Microsoft SQL Server.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 47

def security_protocol
  @security_protocol
end

#should_validate_server_certificate ⇒ BOOLEAN

If set to true, the driver validates the certificate that is sent by the database server.

Returns:

  • (BOOLEAN) 


58
59
60
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 58

def should_validate_server_certificate
  @should_validate_server_certificate
end

#ssl_ca ⇒ String

Database Certificate - The base64 encoded content of a .pem or .crt file. containing the server public key (for 1-way SSL).

Returns:

  • (String) 


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

def ssl_ca
  @ssl_ca
end

#username ⇒ String

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

Returns:

  • (String) 


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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 70

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_ca': :'sslCa',
    'should_validate_server_certificate': :'shouldValidateServerCertificate',
    'private_ip': :'privateIp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 96

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_ca': :'String',
    'should_validate_server_certificate': :'BOOLEAN',
    '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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 206

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_ca == other.ssl_ca &&
    should_validate_server_certificate == other.should_validate_server_certificate &&
    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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 253

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


233
234
235
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 233

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 242

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_ca, should_validate_server_certificate, 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



286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 286

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



280
281
282
 
# File 'lib/oci/golden_gate/models/update_microsoft_sqlserver_connection_details.rb', line 280

def to_s
  to_hash.to_s
end