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, #freeform_tags, #key_id, #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

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

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

  • :trust_store (String)

    The value to assign to the #trust_store property

  • :trust_store_password (String)

    The value to assign to the #trust_store_password property

  • :key_store (String)

    The value to assign to the #key_store property

  • :key_store_password (String)

    The value to assign to the #key_store_password property

  • :ssl_key_password (String)

    The value to assign to the #ssl_key_password property

  • :private_ip (String)

    The value to assign to the #private_ip property



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 166

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.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_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.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_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.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.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)


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_storeString

The base64 encoded content of the KeyStore file.

Returns:

  • (String)


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

def key_store
  @key_store
end

#key_store_passwordString

The KeyStore password.

Returns:

  • (String)


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

def key_store_password
  @key_store_password
end

#passwordString

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

Returns:

  • (String)


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

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


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

def private_ip
  @private_ip
end

#ssl_key_passwordString

The password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided.

Returns:

  • (String)


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

def ssl_key_password
  @ssl_key_password
end

#technology_typeString

[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_storeString

The base64 encoded content of the TrustStore file.

Returns:

  • (String)


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

def trust_store
  @trust_store
end

#trust_store_passwordString

The TrustStore password.

Returns:

  • (String)


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

def trust_store_password
  @trust_store_password
end

#urlString

[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

#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)


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_mapObject

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 80

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',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'technology_type': :'technologyType',
    'url': :'url',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'password': :'password',
    'trust_store': :'trustStore',
    'trust_store_password': :'trustStorePassword',
    'key_store': :'keyStore',
    'key_store_password': :'keyStorePassword',
    'ssl_key_password': :'sslKeyPassword',
    'private_ip': :'privateIp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 110

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>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'technology_type': :'String',
    'url': :'String',
    'authentication_type': :'String',
    'username': :'String',
    'password': :'String',
    'trust_store': :'String',
    'trust_store_password': :'String',
    'key_store': :'String',
    'key_store_password': :'String',
    'ssl_key_password': :'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



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

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 &&
    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 &&
    technology_type == other.technology_type &&
    url == other.url &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    password == other.password &&
    trust_store == other.trust_store &&
    trust_store_password == other.trust_store_password &&
    key_store == other.key_store &&
    key_store_password == other.key_store_password &&
    ssl_key_password == other.ssl_key_password &&
    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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 289

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


269
270
271
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 269

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



278
279
280
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 278

def hash
  [connection_type, display_name, description, compartment_id, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, technology_type, url, authentication_type, username, password, trust_store, trust_store_password, key_store, key_store_password, ssl_key_password, private_ip].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
331
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 322

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



316
317
318
# File 'lib/oci/golden_gate/models/create_kafka_schema_registry_connection_details.rb', line 316

def to_s
  to_hash.to_s
end