Class: OCI::GoldenGate::Models::OracleConnectionSummary
- Inherits:
-
ConnectionSummary
- Object
- ConnectionSummary
- OCI::GoldenGate::Models::OracleConnectionSummary
- Defined in:
- lib/oci/golden_gate/models/oracle_connection_summary.rb
Overview
Summary of the Oracle Connection.
Constant Summary
Constants inherited from ConnectionSummary
ConnectionSummary::CONNECTION_TYPE_ENUM
Instance Attribute Summary collapse
-
#connection_string ⇒ String
Connect descriptor or Easy Connect Naming method used to connect to a database.
-
#database_id ⇒ String
The OCID of the database being referenced.
-
#private_ip ⇒ String
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).
-
#session_mode ⇒ String
The mode of the database connection session to be established by the data client.
-
#technology_type ⇒ String
[Required] The Oracle technology type.
-
#username ⇒ String
[Required] The username Oracle GoldenGate uses to connect the associated system of the given technology.
Attributes inherited from ConnectionSummary
#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
-
.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 = {}) ⇒ OracleConnectionSummary
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 = {}) ⇒ OracleConnectionSummary
Initializes the object
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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 141 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['connectionType'] = 'ORACLE' 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.username = attributes[:'username'] if attributes[:'username'] self.connection_string = attributes[:'connectionString'] if attributes[:'connectionString'] raise 'You cannot provide both :connectionString and :connection_string' if attributes.key?(:'connectionString') && attributes.key?(:'connection_string') self.connection_string = attributes[:'connection_string'] if attributes[:'connection_string'] self.session_mode = attributes[:'sessionMode'] if attributes[:'sessionMode'] self.session_mode = "DIRECT" if session_mode.nil? && !attributes.key?(:'sessionMode') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :sessionMode and :session_mode' if attributes.key?(:'sessionMode') && attributes.key?(:'session_mode') self.session_mode = attributes[:'session_mode'] if attributes[:'session_mode'] self.session_mode = "DIRECT" if session_mode.nil? && !attributes.key?(:'sessionMode') && !attributes.key?(:'session_mode') # rubocop:disable Style/StringLiterals 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.database_id = attributes[:'databaseId'] if attributes[:'databaseId'] raise 'You cannot provide both :databaseId and :database_id' if attributes.key?(:'databaseId') && attributes.key?(:'database_id') self.database_id = attributes[:'database_id'] if attributes[:'database_id'] end |
Instance Attribute Details
#connection_string ⇒ String
Connect descriptor or Easy Connect Naming method used to connect to a database.
27 28 29 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 27 def connection_string @connection_string end |
#database_id ⇒ String
The OCID of the database being referenced.
49 50 51 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 49 def database_id @database_id end |
#private_ip ⇒ String
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.
44 45 46 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 44 def private_ip @private_ip end |
#session_mode ⇒ String
The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
35 36 37 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 35 def session_mode @session_mode end |
#technology_type ⇒ String
[Required] The Oracle technology type.
15 16 17 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 15 def technology_type @technology_type end |
#username ⇒ String
[Required] 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.
22 23 24 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 22 def username @username end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 52 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', 'username': :'username', 'connection_string': :'connectionString', 'session_mode': :'sessionMode', 'private_ip': :'privateIp', 'database_id': :'databaseId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 108 109 110 111 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 83 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', 'username': :'String', 'connection_string': :'String', 'session_mode': :'String', 'private_ip': :'String', 'database_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
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 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 193 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 && technology_type == other.technology_type && username == other.username && connection_string == other.connection_string && session_mode == other.session_mode && private_ip == other.private_ip && database_id == other.database_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
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/oracle_connection_summary.rb', line 245 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
225 226 227 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 225 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
234 235 236 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 234 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, technology_type, username, connection_string, session_mode, private_ip, database_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
278 279 280 281 282 283 284 285 286 287 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 278 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
272 273 274 |
# File 'lib/oci/golden_gate/models/oracle_connection_summary.rb', line 272 def to_s to_hash.to_s end |