Class: OCI::GoldenGate::Models::CreateDatabricksConnectionDetails

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

Overview

The information about a new Databricks 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 = {}) ⇒ CreateDatabricksConnectionDetails

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

  • :authentication_type (String) —

    The value to assign to the #authentication_type property

  • :connection_url (String) —

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

  • :client_id (String) —

    The value to assign to the #client_id property

  • :client_secret (String) —

    The value to assign to the #client_secret property

  • :client_secret_secret_id (String) —

    The value to assign to the #client_secret_secret_id property

  • :storage_credential_name (String) —

    The value to assign to the #storage_credential_name property



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
204
205
206
207
208
209
210
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 151

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

  attributes['connectionType'] = 'DATABRICKS'

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

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

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

  self.client_secret = attributes[:'clientSecret'] if attributes[:'clientSecret']

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

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

  self.client_secret_secret_id = attributes[:'clientSecretSecretId'] if attributes[:'clientSecretSecretId']

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

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

  self.storage_credential_name = attributes[:'storageCredentialName'] if attributes[:'storageCredentialName']

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

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

Instance Attribute Details

#authentication_type ⇒ String

[Required] Used authentication mechanism to access Databricks.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 20

def authentication_type
  @authentication_type
end

#client_id ⇒ String

OAuth client id, only applicable for authenticationType == OAUTH_M2M

Returns:

  • (String) 


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

def client_id
  @client_id
end

#client_secret ⇒ String

OAuth client secret, only applicable for authenticationType == OAUTH_M2M Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 50

def client_secret
  @client_secret
end

#client_secret_secret_id ⇒ String

The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 57

def client_secret_secret_id
  @client_secret_secret_id
end

#connection_url ⇒ String

[Required] Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'

Returns:

  • (String) 


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

def connection_url
  @connection_url
end

#password ⇒ String

The password used to connect to Databricks. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret where the password is stored. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


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

def password_secret_id
  @password_secret_id
end

#storage_credential_name ⇒ String

Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 62

def storage_credential_name
  @storage_credential_name
end

#technology_type ⇒ String

[Required] The Databricks technology type.

Returns:

  • (String) 


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

def technology_type
  @technology_type
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
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
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 65

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',
    'authentication_type': :'authenticationType',
    'connection_url': :'connectionUrl',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'client_id': :'clientId',
    'client_secret': :'clientSecret',
    'client_secret_secret_id': :'clientSecretSecretId',
    'storage_credential_name': :'storageCredentialName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
121
122
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 95

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',
    'authentication_type': :'String',
    'connection_url': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'client_id': :'String',
    'client_secret': :'String',
    'client_secret_secret_id': :'String',
    'storage_credential_name': :'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



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

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 &&
    authentication_type == other.authentication_type &&
    connection_url == other.connection_url &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    client_id == other.client_id &&
    client_secret == other.client_secret &&
    client_secret_secret_id == other.client_secret_secret_id &&
    storage_credential_name == other.storage_credential_name
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 270

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 259

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, authentication_type, connection_url, password, password_secret_id, client_id, client_secret, client_secret_secret_id, storage_credential_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/golden_gate/models/create_databricks_connection_details.rb', line 303

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



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

def to_s
  to_hash.to_s
end