Class: OCI::GoldenGate::Models::CreateKafkaSchemaRegistryConnectionDetails

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

Overview

The information about a new Kafka (e.g. Confluent) Schema Registry 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 = {}) ⇒ CreateKafkaSchemaRegistryConnectionDetails

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

  • :url (String) —

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

  • :trust_store (String) —

    The value to assign to the #trust_store property

  • :trust_store_secret_id (String) —

    The value to assign to the #trust_store_secret_id property

  • :trust_store_password (String) —

    The value to assign to the #trust_store_password property

  • :trust_store_password_secret_id (String) —

    The value to assign to the #trust_store_password_secret_id property

  • :key_store (String) —

    The value to assign to the #key_store property

  • :key_store_secret_id (String) —

    The value to assign to the #key_store_secret_id property

  • :key_store_password (String) —

    The value to assign to the #key_store_password property

  • :key_store_password_secret_id (String) —

    The value to assign to the #key_store_password_secret_id property

  • :ssl_key_password (String) —

    The value to assign to the #ssl_key_password property

  • :ssl_key_password_secret_id (String) —

    The value to assign to the #ssl_key_password_secret_id property

  • :private_ip (String) —

    The value to assign to the #private_ip property



235
236
237
238
239
240
241
242
243
244
245
246
247
248
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 235

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

  attributes['connectionType'] = 'KAFKA_SCHEMA_REGISTRY'

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

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

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

  self.trust_store_secret_id = attributes[:'trustStoreSecretId'] if attributes[:'trustStoreSecretId']

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

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

  self.trust_store_password = attributes[:'trustStorePassword'] if attributes[:'trustStorePassword']

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

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

  self.trust_store_password_secret_id = attributes[:'trustStorePasswordSecretId'] if attributes[:'trustStorePasswordSecretId']

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

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

  self.key_store = attributes[:'keyStore'] if attributes[:'keyStore']

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

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

  self.key_store_secret_id = attributes[:'keyStoreSecretId'] if attributes[:'keyStoreSecretId']

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

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

  self.key_store_password = attributes[:'keyStorePassword'] if attributes[:'keyStorePassword']

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

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

  self.key_store_password_secret_id = attributes[:'keyStorePasswordSecretId'] if attributes[:'keyStorePasswordSecretId']

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

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

  self.ssl_key_password = attributes[:'sslKeyPassword'] if attributes[:'sslKeyPassword']

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

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

  self.ssl_key_password_secret_id = attributes[:'sslKeyPasswordSecretId'] if attributes[:'sslKeyPasswordSecretId']

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

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

  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

#authentication_type ⇒ String

[Required] Used authentication mechanism to access Schema Registry.

Returns:

  • (String) 


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

def authentication_type
  @authentication_type
end

#key_store ⇒ String

The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 78

def key_store
  @key_store
end

#key_store_password ⇒ String

The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 90

def key_store_password
  @key_store_password
end

#key_store_password_secret_id ⇒ String

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

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 96

def key_store_password_secret_id
  @key_store_password_secret_id
end

#key_store_secret_id ⇒ String

The OCID of the Secret that stores the content of the KeyStore file. Note: When provided, 'keyStore' field must not be provided.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 84

def key_store_secret_id
  @key_store_secret_id
end

#password ⇒ String

The password to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret where the Kafka Schema Registry password is stored, The password to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 48

def password_secret_id
  @password_secret_id
end

#private_ip ⇒ String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

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) 


122
123
124
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 122

def private_ip
  @private_ip
end

#ssl_key_password ⇒ String

The password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 103

def ssl_key_password
  @ssl_key_password
end

#ssl_key_password_secret_id ⇒ String

The OCID of the Secret that stores the password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 110

def ssl_key_password_secret_id
  @ssl_key_password_secret_id
end

#technology_type ⇒ String

[Required] The Kafka (e.g. Confluent) Schema Registry technology type.

Returns:

  • (String) 


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

def technology_type
  @technology_type
end

#trust_store ⇒ String

The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 54

def trust_store
  @trust_store
end

#trust_store_password ⇒ String

The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def trust_store_password
  @trust_store_password
end

#trust_store_password_secret_id ⇒ String

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

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 72

def trust_store_password_secret_id
  @trust_store_password_secret_id
end

#trust_store_secret_id ⇒ String

The OCID of the Secret that stores the content of the TrustStore file. Note: When provided, 'trustStore' field must not be provided.

Returns:

  • (String) 


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

def trust_store_secret_id
  @trust_store_secret_id
end

#url ⇒ String

[Required] Kafka Schema Registry URL. e.g.: 'server1.us.oracle.com:8081'

Returns:

  • (String) 


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

def url
  @url
end

#username ⇒ String

The username to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_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.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 125

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',
    'url': :'url',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'trust_store': :'trustStore',
    'trust_store_secret_id': :'trustStoreSecretId',
    'trust_store_password': :'trustStorePassword',
    'trust_store_password_secret_id': :'trustStorePasswordSecretId',
    'key_store': :'keyStore',
    'key_store_secret_id': :'keyStoreSecretId',
    'key_store_password': :'keyStorePassword',
    'key_store_password_secret_id': :'keyStorePasswordSecretId',
    'ssl_key_password': :'sslKeyPassword',
    'ssl_key_password_secret_id': :'sslKeyPasswordSecretId',
    'private_ip': :'privateIp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'url': :'String',
    'authentication_type': :'String',
    'username': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'trust_store': :'String',
    'trust_store_secret_id': :'String',
    'trust_store_password': :'String',
    'trust_store_password_secret_id': :'String',
    'key_store': :'String',
    'key_store_secret_id': :'String',
    'key_store_password': :'String',
    'key_store_password_secret_id': :'String',
    'ssl_key_password': :'String',
    'ssl_key_password_secret_id': :'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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 343

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 &&
    url == other.url &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    trust_store == other.trust_store &&
    trust_store_secret_id == other.trust_store_secret_id &&
    trust_store_password == other.trust_store_password &&
    trust_store_password_secret_id == other.trust_store_password_secret_id &&
    key_store == other.key_store &&
    key_store_secret_id == other.key_store_secret_id &&
    key_store_password == other.key_store_password &&
    key_store_password_secret_id == other.key_store_password_secret_id &&
    ssl_key_password == other.ssl_key_password &&
    ssl_key_password_secret_id == other.ssl_key_password_secret_id &&
    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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 402

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


382
383
384
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 382

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



391
392
393
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 391

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, url, authentication_type, username, password, password_secret_id, trust_store, trust_store_secret_id, trust_store_password, trust_store_password_secret_id, key_store, key_store_secret_id, key_store_password, key_store_password_secret_id, ssl_key_password, ssl_key_password_secret_id, 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



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 435

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



429
430
431
 
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 429

def to_s
  to_hash.to_s
end