Class: OCI::GoldenGate::Models::CreateDatabaseRegistrationDetails
- Inherits:
-
Object
- Object
- OCI::GoldenGate::Models::CreateDatabaseRegistrationDetails
- Defined in:
- lib/oci/golden_gate/models/create_database_registration_details.rb
Overview
The information about a new DatabaseRegistration.
Constant Summary collapse
- SESSION_MODE_ENUM =
[ SESSION_MODE_DIRECT = 'DIRECT'.freeze, SESSION_MODE_REDIRECT = 'REDIRECT'.freeze ].freeze
Instance Attribute Summary collapse
-
#alias_name ⇒ String
[Required] Credential store alias.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment being referenced.
-
#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.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Tags defined for this resource.
-
#description ⇒ String
Metadata about this specific object.
-
#display_name ⇒ String
[Required] An object's Display Name.
-
#fqdn ⇒ String
[Required] A three-label Fully Qualified Domain Name (FQDN) for a resource.
-
#freeform_tags ⇒ Hash<String, String>
A simple key-value pair that is applied without any predefined name, type, or scope.
-
#ip_address ⇒ String
The private IP address in the customer's VCN of the customer's endpoint, typically a database.
-
#key_id ⇒ String
Refers to the customer's master key OCID.
-
#password ⇒ String
[Required] The password Oracle GoldenGate uses to connect the associated system of the given technology.
-
#secret_compartment_id ⇒ String
The OCID of the compartment where the GoldenGate Secret will be created.
-
#session_mode ⇒ String
The mode of the database connection session to be established by the data client.
-
#subnet_id ⇒ String
The OCID of the target subnet of the dedicated connection.
-
#username ⇒ String
[Required] The username Oracle GoldenGate uses to connect the associated system of the given technology.
-
#vault_id ⇒ String
Refers to the customer's vault OCID.
-
#wallet ⇒ String
The wallet contents Oracle GoldenGate uses to make connections to a database.
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 = {}) ⇒ CreateDatabaseRegistrationDetails
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.
Constructor Details
#initialize(attributes = {}) ⇒ CreateDatabaseRegistrationDetails
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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 200 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.description = attributes[:'description'] if attributes[:'description'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.fqdn = attributes[:'fqdn'] if attributes[:'fqdn'] self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress'] raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address') self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address'] self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId'] raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id') self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_id'] 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'] self.username = attributes[:'username'] if attributes[:'username'] self.password = attributes[:'password'] if attributes[:'password'] 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.wallet = attributes[:'wallet'] if attributes[:'wallet'] self.alias_name = attributes[:'aliasName'] if attributes[:'aliasName'] raise 'You cannot provide both :aliasName and :alias_name' if attributes.key?(:'aliasName') && attributes.key?(:'alias_name') self.alias_name = attributes[:'alias_name'] if attributes[:'alias_name'] self.vault_id = attributes[:'vaultId'] if attributes[:'vaultId'] raise 'You cannot provide both :vaultId and :vault_id' if attributes.key?(:'vaultId') && attributes.key?(:'vault_id') self.vault_id = attributes[:'vault_id'] if attributes[:'vault_id'] self.key_id = attributes[:'keyId'] if attributes[:'keyId'] raise 'You cannot provide both :keyId and :key_id' if attributes.key?(:'keyId') && attributes.key?(:'key_id') self.key_id = attributes[:'key_id'] if attributes[:'key_id'] self.secret_compartment_id = attributes[:'secretCompartmentId'] if attributes[:'secretCompartmentId'] raise 'You cannot provide both :secretCompartmentId and :secret_compartment_id' if attributes.key?(:'secretCompartmentId') && attributes.key?(:'secret_compartment_id') self.secret_compartment_id = attributes[:'secret_compartment_id'] if attributes[:'secret_compartment_id'] end |
Instance Attribute Details
#alias_name ⇒ String
[Required] Credential store alias.
103 104 105 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 103 def alias_name @alias_name end |
#compartment_id ⇒ String
[Required] The OCID of the compartment being referenced.
30 31 32 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 30 def compartment_id @compartment_id end |
#connection_string ⇒ String
Connect descriptor or Easy Connect Naming method used to connect to a database.
84 85 86 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 84 def connection_string @connection_string end |
#database_id ⇒ String
The OCID of the database being referenced.
66 67 68 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 66 def database_id @database_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
45 46 47 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 45 def @defined_tags end |
#description ⇒ String
Metadata about this specific object.
25 26 27 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 25 def description @description end |
#display_name ⇒ String
[Required] An object's Display Name.
20 21 22 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 20 def display_name @display_name end |
#fqdn ⇒ String
[Required] A three-label Fully Qualified Domain Name (FQDN) for a resource.
50 51 52 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 50 def fqdn @fqdn end |
#freeform_tags ⇒ Hash<String, String>
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: {\"bar-key\": \"value\"}
38 39 40 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 38 def @freeform_tags end |
#ip_address ⇒ String
The private IP address in the customer's VCN of the customer's endpoint, typically a database.
56 57 58 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 56 def ip_address @ip_address end |
#key_id ⇒ String
Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
116 117 118 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 116 def key_id @key_id end |
#password ⇒ String
[Required] The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on.
79 80 81 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 79 def password @password end |
#secret_compartment_id ⇒ String
The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
122 123 124 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 122 def secret_compartment_id @secret_compartment_id 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.
92 93 94 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 92 def session_mode @session_mode end |
#subnet_id ⇒ String
The OCID of the target subnet of the dedicated connection.
61 62 63 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 61 def subnet_id @subnet_id 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.
73 74 75 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 73 def username @username end |
#vault_id ⇒ String
Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
110 111 112 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 110 def vault_id @vault_id end |
#wallet ⇒ String
The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.
98 99 100 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 98 def wallet @wallet end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 125 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'description': :'description', 'compartment_id': :'compartmentId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'fqdn': :'fqdn', 'ip_address': :'ipAddress', 'subnet_id': :'subnetId', 'database_id': :'databaseId', 'username': :'username', 'password': :'password', 'connection_string': :'connectionString', 'session_mode': :'sessionMode', 'wallet': :'wallet', 'alias_name': :'aliasName', 'vault_id': :'vaultId', 'key_id': :'keyId', 'secret_compartment_id': :'secretCompartmentId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 151 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'description': :'String', 'compartment_id': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'fqdn': :'String', 'ip_address': :'String', 'subnet_id': :'String', 'database_id': :'String', 'username': :'String', 'password': :'String', 'connection_string': :'String', 'session_mode': :'String', 'wallet': :'String', 'alias_name': :'String', 'vault_id': :'String', 'key_id': :'String', 'secret_compartment_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 312 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && description == other.description && compartment_id == other.compartment_id && == other. && == other. && fqdn == other.fqdn && ip_address == other.ip_address && subnet_id == other.subnet_id && database_id == other.database_id && username == other.username && password == other.password && connection_string == other.connection_string && session_mode == other.session_mode && wallet == other.wallet && alias_name == other.alias_name && vault_id == other.vault_id && key_id == other.key_id && secret_compartment_id == other.secret_compartment_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 359 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
339 340 341 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 339 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
348 349 350 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 348 def hash [display_name, description, compartment_id, , , fqdn, ip_address, subnet_id, database_id, username, password, connection_string, session_mode, wallet, alias_name, vault_id, key_id, secret_compartment_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
392 393 394 395 396 397 398 399 400 401 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 392 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
386 387 388 |
# File 'lib/oci/golden_gate/models/create_database_registration_details.rb', line 386 def to_s to_hash.to_s end |