Class: OCI::GoldenGate::Models::KafkaSchemaRegistryConnectionSummary
- Inherits:
-
ConnectionSummary
- Object
- ConnectionSummary
- OCI::GoldenGate::Models::KafkaSchemaRegistryConnectionSummary
- Defined in:
- lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb
Overview
Summary of the Kafka (e.g. Confluent) Schema Registry Connection.
Constant Summary
Constants inherited from ConnectionSummary
ConnectionSummary::CONNECTION_TYPE_ENUM, ConnectionSummary::ROUTING_METHOD_ENUM
Instance Attribute Summary collapse
-
#authentication_type ⇒ String
[Required] Used authentication mechanism to access Schema Registry.
-
#key_store_password_secret_id ⇒ String
The OCID of the Secret where the kafka Ssl KeyStore password is stored.
-
#key_store_secret_id ⇒ String
The OCID of the Secret that stores the content of the KeyStore file.
-
#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.
-
#private_ip ⇒ String
Deprecated: this field will be removed in future versions.
-
#ssl_key_password_secret_id ⇒ String
The OCID of the Secret that stores the password for the cert inside the KeyStore.
-
#technology_type ⇒ String
[Required] The Kafka (e.g. Confluent) Schema Registry technology type.
-
#trust_store_password_secret_id ⇒ String
The OCID of the Secret where the kafka Ssl TrustStore password is stored.
-
#trust_store_secret_id ⇒ String
The OCID of the Secret that stores the content of the TrustStore file.
-
#url ⇒ String
[Required] Kafka Schema Registry URL.
-
#username ⇒ String
The username to access Schema Registry using basic authentication.
Attributes inherited from ConnectionSummary
#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, #subnet_id, #system_tags, #time_created, #time_updated, #vault_id
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ KafkaSchemaRegistryConnectionSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Methods inherited from ConnectionSummary
Constructor Details
#initialize(attributes = {}) ⇒ KafkaSchemaRegistryConnectionSummary
Initializes the object
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 230 231 232 233 234 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 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 200 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'] 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'] end |
Instance Attribute Details
#authentication_type ⇒ String
[Required] Used authentication mechanism to access Schema Registry.
27 28 29 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 27 def authentication_type @authentication_type 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.
77 78 79 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 77 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.
71 72 73 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 71 def key_store_secret_id @key_store_secret_id 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.
53 54 55 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 53 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.
45 46 47 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 45 def private_ip @private_ip 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.
84 85 86 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 84 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.
16 17 18 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 16 def technology_type @technology_type 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.
65 66 67 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 65 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.
59 60 61 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 59 def trust_store_secret_id @trust_store_secret_id end |
#url ⇒ String
[Required] Kafka Schema Registry URL. e.g.: 'server1.us.oracle.com:8081'
22 23 24 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.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.
33 34 35 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 33 def username @username end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
87 88 89 90 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 119 120 121 122 123 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 87 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', 'locks': :'locks', 'does_use_secret_ids': :'doesUseSecretIds', 'technology_type': :'technologyType', 'url': :'url', 'authentication_type': :'authenticationType', 'username': :'username', 'private_ip': :'privateIp', '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' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 161 162 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 126 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', 'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>', 'does_use_secret_ids': :'BOOLEAN', 'technology_type': :'String', 'url': :'String', 'authentication_type': :'String', 'username': :'String', 'private_ip': :'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' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
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 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 276 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 && == other. && == other. && == other. && 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 && locks == other.locks && 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 && private_ip == other.private_ip && 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 end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 336 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
316 317 318 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 316 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
325 326 327 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 325 def hash [connection_type, id, display_name, description, compartment_id, , , , lifecycle_state, lifecycle_details, time_created, time_updated, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, locks, does_use_secret_ids, technology_type, url, authentication_type, username, private_ip, 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].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
369 370 371 372 373 374 375 376 377 378 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 369 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
363 364 365 |
# File 'lib/oci/golden_gate/models/kafka_schema_registry_connection_summary.rb', line 363 def to_s to_hash.to_s end |