Class: OCI::GoldenGate::Models::UpdateSnowflakeConnectionDetails

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

Overview

The information to update a Snowflake Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::UpdateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSnowflakeConnectionDetails

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

  • :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

  • :connection_url (String) —

    The value to assign to the #connection_url property

  • :authentication_type (String) —

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

  • :private_key_file (String) —

    The value to assign to the #private_key_file property

  • :private_key_file_secret_id (String) —

    The value to assign to the #private_key_file_secret_id property

  • :private_key_passphrase (String) —

    The value to assign to the #private_key_passphrase property

  • :private_key_passphrase_secret_id (String) —

    The value to assign to the #private_key_passphrase_secret_id property



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
198
199
200
201
202
203
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 148

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

  attributes['connectionType'] = 'SNOWFLAKE'

  super(attributes)

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

  self.connection_url = attributes[:'connectionUrl'] if attributes[:'connectionUrl']

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

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

  self.authentication_type = attributes[:'authenticationType'] if attributes[:'authenticationType']

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

  self.authentication_type = attributes[:'authentication_type'] if attributes[:'authentication_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.private_key_file = attributes[:'privateKeyFile'] if attributes[:'privateKeyFile']

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

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

  self.private_key_file_secret_id = attributes[:'privateKeyFileSecretId'] if attributes[:'privateKeyFileSecretId']

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

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

  self.private_key_passphrase = attributes[:'privateKeyPassphrase'] if attributes[:'privateKeyPassphrase']

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

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

  self.private_key_passphrase_secret_id = attributes[:'privateKeyPassphraseSecretId'] if attributes[:'privateKeyPassphraseSecretId']

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

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

Instance Attribute Details

#authentication_type ⇒ String

Used authentication mechanism to access Snowflake.

Returns:

  • (String) 


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

def authentication_type
  @authentication_type
end

#connection_url ⇒ String

JDBC connection URL. e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>'

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 17

def connection_url
  @connection_url
end

#password ⇒ String

The password Oracle GoldenGate uses to connect to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Snowflake platform. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 40

def password_secret_id
  @password_secret_id
end

#private_key_file ⇒ String

The base64 encoded content of private key file in PEM format. Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 46

def private_key_file
  @private_key_file
end

#private_key_file_secret_id ⇒ String

The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.

Returns:

  • (String) 


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

def private_key_file_secret_id
  @private_key_file_secret_id
end

#private_key_passphrase ⇒ String

Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def private_key_passphrase
  @private_key_passphrase
end

#private_key_passphrase_secret_id ⇒ String

The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 65

def private_key_passphrase_secret_id
  @private_key_passphrase_secret_id
end

#username ⇒ String

The username Oracle GoldenGate uses to connect to Snowflake. This username must already exist and be available by Snowflake platform to be connected to.

Returns:

  • (String) 


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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
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_snowflake_connection_details.rb', line 68

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',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'connection_url': :'connectionUrl',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'private_key_file': :'privateKeyFile',
    'private_key_file_secret_id': :'privateKeyFileSecretId',
    'private_key_passphrase': :'privateKeyPassphrase',
    'private_key_passphrase_secret_id': :'privateKeyPassphraseSecretId'
    # 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
120
121
 
# File 'lib/oci/golden_gate/models/update_snowflake_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>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'connection_url': :'String',
    'authentication_type': :'String',
    'username': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'private_key_file': :'String',
    'private_key_file_secret_id': :'String',
    'private_key_passphrase': :'String',
    'private_key_passphrase_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



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

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 &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    connection_url == other.connection_url &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    private_key_file == other.private_key_file &&
    private_key_file_secret_id == other.private_key_file_secret_id &&
    private_key_passphrase == other.private_key_passphrase &&
    private_key_passphrase_secret_id == other.private_key_passphrase_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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 261

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


241
242
243
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 241

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



250
251
252
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 250

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, connection_url, authentication_type, username, password, password_secret_id, private_key_file, private_key_file_secret_id, private_key_passphrase, private_key_passphrase_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



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/golden_gate/models/update_snowflake_connection_details.rb', line 294

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



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

def to_s
  to_hash.to_s
end