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_OCI_STREAMING = 'OCI_STREAMING'.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

Instance Attribute Summary collapse

Attributes inherited from Connection

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #nsg_ids, #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 = {}) ⇒ KafkaConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

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

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

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

  • :ingress_ips (Array<OCI::GoldenGate::Models::IngressIpDetails>) —

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

  • :technology_type (String) —

    The value to assign to the #technology_type property

  • :stream_pool_id (String) —

    The value to assign to the #stream_pool_id property

  • :bootstrap_servers (Array<OCI::GoldenGate::Models::KafkaBootstrapServer>) —

    The value to assign to the #bootstrap_servers property

  • :security_protocol (String) —

    The value to assign to the #security_protocol property

  • :username (String) —

    The value to assign to the #username property



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

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.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']
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:



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

def bootstrap_servers
  @bootstrap_servers
end

#security_protocol ⇒ String

Kafka security protocol.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 51

def security_protocol
  @security_protocol
end

#stream_pool_id ⇒ String

The OCID of the stream pool being referenced.

Returns:

  • (String) 


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

def stream_pool_id
  @stream_pool_id
end

#technology_type ⇒ String

[Required] The Kafka technology type.

Returns:

  • (String) 


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

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


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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 61

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',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'technology_type': :'technologyType',
    'stream_pool_id': :'streamPoolId',
    'bootstrap_servers': :'bootstrapServers',
    'security_protocol': :'securityProtocol',
    'username': :'username'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 91

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',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'technology_type': :'String',
    'stream_pool_id': :'String',
    'bootstrap_servers': :'Array<OCI::GoldenGate::Models::KafkaBootstrapServer>',
    'security_protocol': :'String',
    'username': :'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



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

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 &&
    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 &&
    technology_type == other.technology_type &&
    stream_pool_id == other.stream_pool_id &&
    bootstrap_servers == other.bootstrap_servers &&
    security_protocol == other.security_protocol &&
    username == other.username
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



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

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


248
249
250
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 248

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 257

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, technology_type, stream_pool_id, bootstrap_servers, security_protocol, username].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 301

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



295
296
297
 
# File 'lib/oci/golden_gate/models/kafka_connection.rb', line 295

def to_s
  to_hash.to_s
end