Class: OCI::GoldenGate::Models::KafkaSchemaRegistryConnection

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

Overview

Represents the metadata of a Kafka (e.g. Confluent) Schema Registry Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM =
[
  TECHNOLOGY_TYPE_CONFLUENT_SCHEMA_REGISTRY = 'CONFLUENT_SCHEMA_REGISTRY'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTHENTICATION_TYPE_ENUM =
[
  AUTHENTICATION_TYPE_NONE = 'NONE'.freeze,
  AUTHENTICATION_TYPE_BASIC = 'BASIC'.freeze,
  AUTHENTICATION_TYPE_MUTUAL = 'MUTUAL'.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, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #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 = {}) ⇒ KafkaSchemaRegistryConnection

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

  • :routing_method (String)

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

  • :private_ip (String)

    The value to assign to the #private_ip property



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

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

[Required] Used authentication mechanism to access Schema Registry.

Returns:

  • (String)


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

def authentication_type
  @authentication_type
end

#private_ipString

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)


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

def private_ip
  @private_ip
end

#technology_typeString

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

Returns:

  • (String)


29
30
31
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection.rb', line 29

def technology_type
  @technology_type
end

#urlString

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

Returns:

  • (String)


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

def url
  @url
end

#usernameString

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

Returns:

  • (String)


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

def username
  @username
end

Class Method Details

.attribute_mapObject

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
89
# File 'lib/oci/golden_gate/models/kafka_schema_registry_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',
    'routing_method': :'routingMethod',
    'technology_type': :'technologyType',
    'url': :'url',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'private_ip': :'privateIp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
119
120
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection.rb', line 92

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',
    'routing_method': :'String',
    'technology_type': :'String',
    'url': :'String',
    'authentication_type': :'String',
    'username': :'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



216
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_schema_registry_connection.rb', line 216

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 &&
    routing_method == other.routing_method &&
    technology_type == other.technology_type &&
    url == other.url &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    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



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_schema_registry_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_schema_registry_connection.rb', line 248

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



257
258
259
# File 'lib/oci/golden_gate/models/kafka_schema_registry_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, routing_method, technology_type, url, authentication_type, username, private_ip].hash
end

#to_hashHash

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_schema_registry_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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

def to_s
  to_hash.to_s
end