Class: OCI::GoldenGate::Models::SnowflakeConnection

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

Overview

Represents the metadata of a Snowflake Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM = 
[
  TECHNOLOGY_TYPE_SNOWFLAKE = 'SNOWFLAKE'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTHENTICATION_TYPE_ENUM = 
[
  AUTHENTICATION_TYPE_BASIC = 'BASIC'.freeze,
  AUTHENTICATION_TYPE_KEY_PAIR = 'KEY_PAIR'.freeze,
  AUTHENTICATION_TYPE_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

#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, #subnet_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 = {}) ⇒ SnowflakeConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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.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.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_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_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_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

[Required] Used authentication mechanism to access Snowflake.

Returns:

  • (String) 


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

def authentication_type
  @authentication_type
end

#connection_url ⇒ String

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

Returns:

  • (String) 


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

def connection_url
  @connection_url
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) 


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

def password_secret_id
  @password_secret_id
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) 


60
61
62
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 60

def private_key_file_secret_id
  @private_key_file_secret_id
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) 


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

def private_key_passphrase_secret_id
  @private_key_passphrase_secret_id
end

#technology_type ⇒ String

[Required] The Snowflake technology type.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 27

def technology_type
  @technology_type
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) 


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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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
94
95
96
97
98
99
100
101
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 69

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',
    'technology_type': :'technologyType',
    'connection_url': :'connectionUrl',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'password_secret_id': :'passwordSecretId',
    'private_key_file_secret_id': :'privateKeyFileSecretId',
    'private_key_passphrase_secret_id': :'privateKeyPassphraseSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
133
134
135
136
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 104

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',
    'technology_type': :'String',
    'connection_url': :'String',
    'authentication_type': :'String',
    'username': :'String',
    'password_secret_id': :'String',
    'private_key_file_secret_id': :'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



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
279
280
281
282
283
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 252

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 &&
    technology_type == other.technology_type &&
    connection_url == other.connection_url &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    password_secret_id == other.password_secret_id &&
    private_key_file_secret_id == other.private_key_file_secret_id &&
    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



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

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



297
298
299
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 297

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, technology_type, connection_url, authentication_type, username, password_secret_id, private_key_file_secret_id, 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



341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 341

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



335
336
337
 
# File 'lib/oci/golden_gate/models/snowflake_connection.rb', line 335

def to_s
  to_hash.to_s
end