Class: OCI::GoldenGate::Models::KafkaConnection

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

Overview

Represents the metadata of a Kafka Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM = 
[
  TECHNOLOGY_TYPE_APACHE_KAFKA = 'APACHE_KAFKA'.freeze,
  TECHNOLOGY_TYPE_AZURE_EVENT_HUBS = 'AZURE_EVENT_HUBS'.freeze,
  TECHNOLOGY_TYPE_CONFLUENT_KAFKA = 'CONFLUENT_KAFKA'.freeze,
  TECHNOLOGY_TYPE_MICROSOFT_FABRIC_EVENTSTREAM = 'MICROSOFT_FABRIC_EVENTSTREAM'.freeze,
  TECHNOLOGY_TYPE_OCI_STREAMING = 'OCI_STREAMING'.freeze,
  TECHNOLOGY_TYPE_OCI_STREAMING_WITH_APACHE_KAFKA = 'OCI_STREAMING_WITH_APACHE_KAFKA'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SECURITY_PROTOCOL_ENUM = 
[
  SECURITY_PROTOCOL_SSL = 'SSL'.freeze,
  SECURITY_PROTOCOL_SASL_SSL = 'SASL_SSL'.freeze,
  SECURITY_PROTOCOL_PLAINTEXT = 'PLAINTEXT'.freeze,
  SECURITY_PROTOCOL_SASL_PLAINTEXT = 'SASL_PLAINTEXT'.freeze,
  SECURITY_PROTOCOL_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

#cluster_placement_group_id, #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, #security_attributes, #subnet_id, #subscription_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 = {}) ⇒ KafkaConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 261

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

  attributes['connectionType'] = 'KAFKA'

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

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

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

  self.cluster_id = attributes[:'clusterId'] if attributes[:'clusterId']

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

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

  self.bootstrap_servers = attributes[:'bootstrapServers'] if attributes[:'bootstrapServers']

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

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

  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.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.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_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_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_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_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.consumer_properties = attributes[:'consumerProperties'] if attributes[:'consumerProperties']

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

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

  self.producer_properties = attributes[:'producerProperties'] if attributes[:'producerProperties']

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

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

  self.should_use_resource_principal = attributes[:'shouldUseResourcePrincipal'] unless attributes[:'shouldUseResourcePrincipal'].nil?

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

  self.should_use_resource_principal = attributes[:'should_use_resource_principal'] unless attributes[:'should_use_resource_principal'].nil?
end

Instance Attribute Details

#bootstrap_servers ⇒ Array<OCI::GoldenGate::Models::KafkaBootstrapServer>

Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: \"server1.example.com:9092,server2.example.com:9092\"

Returns:



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

def bootstrap_servers
  @bootstrap_servers
end

#cluster_id ⇒ String

The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.

Returns:

  • (String) 


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

def cluster_id
  @cluster_id
end

#consumer_properties ⇒ String

The base64 encoded content of the consumer.properties file.

Returns:

  • (String) 


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

def consumer_properties
  @consumer_properties
end

#key_store_password_secret_id ⇒ String

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

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 99

def key_store_password_secret_id
  @key_store_password_secret_id
end

#key_store_secret_id ⇒ String

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

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 93

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


75
76
77
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 75

def password_secret_id
  @password_secret_id
end

#producer_properties ⇒ String

The base64 encoded content of the producer.properties file.

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 115

def producer_properties
  @producer_properties
end

#security_protocol ⇒ String

Kafka security protocol.

Returns:

  • (String) 


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

def security_protocol
  @security_protocol
end

#should_use_resource_principal ⇒ BOOLEAN

Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false

Returns:

  • (BOOLEAN) 


124
125
126
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 124

def should_use_resource_principal
  @should_use_resource_principal
end

#ssl_key_password_secret_id ⇒ String

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

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 105

def ssl_key_password_secret_id
  @ssl_key_password_secret_id
end

#stream_pool_id ⇒ String

The OCID of the stream pool being referenced.

Returns:

  • (String) 


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

def stream_pool_id
  @stream_pool_id
end

#technology_type ⇒ String

[Required] The Kafka technology type.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 35

def technology_type
  @technology_type
end

#trust_store_password_secret_id ⇒ String

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

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 87

def trust_store_password_secret_id
  @trust_store_password_secret_id
end

#trust_store_secret_id ⇒ String

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

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 81

def trust_store_secret_id
  @trust_store_secret_id
end

#username ⇒ String

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:

  • (String) 


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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 127

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',
    'subscription_id': :'subscriptionId',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'security_attributes': :'securityAttributes',
    'technology_type': :'technologyType',
    'stream_pool_id': :'streamPoolId',
    'cluster_id': :'clusterId',
    'bootstrap_servers': :'bootstrapServers',
    'security_protocol': :'securityProtocol',
    'username': :'username',
    'password_secret_id': :'passwordSecretId',
    'trust_store_secret_id': :'trustStoreSecretId',
    'trust_store_password_secret_id': :'trustStorePasswordSecretId',
    'key_store_secret_id': :'keyStoreSecretId',
    'key_store_password_secret_id': :'keyStorePasswordSecretId',
    'ssl_key_password_secret_id': :'sslKeyPasswordSecretId',
    'consumer_properties': :'consumerProperties',
    'producer_properties': :'producerProperties',
    'should_use_resource_principal': :'shouldUseResourcePrincipal'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'subscription_id': :'String',
    'cluster_placement_group_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'technology_type': :'String',
    'stream_pool_id': :'String',
    'cluster_id': :'String',
    'bootstrap_servers': :'Array<OCI::GoldenGate::Models::KafkaBootstrapServer>',
    'security_protocol': :'String',
    'username': :'String',
    'password_secret_id': :'String',
    'trust_store_secret_id': :'String',
    'trust_store_password_secret_id': :'String',
    'key_store_secret_id': :'String',
    'key_store_password_secret_id': :'String',
    'ssl_key_password_secret_id': :'String',
    'consumer_properties': :'String',
    'producer_properties': :'String',
    'should_use_resource_principal': :'BOOLEAN'
    # 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



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 391

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 &&
    subscription_id == other.subscription_id &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    security_attributes == other.security_attributes &&
    technology_type == other.technology_type &&
    stream_pool_id == other.stream_pool_id &&
    cluster_id == other.cluster_id &&
    bootstrap_servers == other.bootstrap_servers &&
    security_protocol == other.security_protocol &&
    username == other.username &&
    password_secret_id == other.password_secret_id &&
    trust_store_secret_id == other.trust_store_secret_id &&
    trust_store_password_secret_id == other.trust_store_password_secret_id &&
    key_store_secret_id == other.key_store_secret_id &&
    key_store_password_secret_id == other.key_store_password_secret_id &&
    ssl_key_password_secret_id == other.ssl_key_password_secret_id &&
    consumer_properties == other.consumer_properties &&
    producer_properties == other.producer_properties &&
    should_use_resource_principal == other.should_use_resource_principal
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



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 458

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


438
439
440
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 438

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



447
448
449
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 447

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, subscription_id, cluster_placement_group_id, security_attributes, technology_type, stream_pool_id, cluster_id, bootstrap_servers, security_protocol, username, password_secret_id, trust_store_secret_id, trust_store_password_secret_id, key_store_secret_id, key_store_password_secret_id, ssl_key_password_secret_id, consumer_properties, producer_properties, should_use_resource_principal].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



491
492
493
494
495
496
497
498
499
500
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 491

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



485
486
487
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 485

def to_s
  to_hash.to_s
end