Class: OCI::Database::Models::CreateDataGuardAssociationDetails
- Inherits:
-
Object
- Object
- OCI::Database::Models::CreateDataGuardAssociationDetails
- Defined in:
- lib/oci/database/models/create_data_guard_association_details.rb
Overview
The configuration details for creating a Data Guard association between databases.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
CreateDataGuardAssociationToExistingDbSystemDetails, CreateDataGuardAssociationToExistingVmClusterDetails, CreateDataGuardAssociationWithNewDbSystemDetails
Constant Summary collapse
- PROTECTION_MODE_ENUM =
[ PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY'.freeze, PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE'.freeze, PROTECTION_MODE_MAXIMUM_PROTECTION = 'MAXIMUM_PROTECTION'.freeze ].freeze
- TRANSPORT_TYPE_ENUM =
[ TRANSPORT_TYPE_SYNC = 'SYNC'.freeze, TRANSPORT_TYPE_ASYNC = 'ASYNC'.freeze, TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'.freeze ].freeze
Instance Attribute Summary collapse
-
#creation_type ⇒ String
[Required] Specifies whether to create the peer database in an existing DB system or in a new DB system.
-
#database_admin_password ⇒ String
[Required] A strong password for the
SYS
,SYSTEM
, andPDB Admin
users to apply during standby creation. -
#database_software_image_id ⇒ String
The database software image OCID.
-
#is_active_data_guard_enabled ⇒ BOOLEAN
True if active Data Guard is enabled.
-
#peer_db_unique_name ⇒ String
Specifies the
DB_UNIQUE_NAME
of the peer database to be created. -
#peer_sid_prefix ⇒ String
Specifies a prefix for the
Oracle SID
of the database to be created. -
#protection_mode ⇒ String
[Required] The protection mode to set up between the primary and standby databases.
- #source_encryption_key_location_details ⇒ OCI::Database::Models::EncryptionKeyLocationDetails
-
#transport_type ⇒ String
[Required] The redo transport type to use for this Data Guard association.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.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 = {}) ⇒ CreateDataGuardAssociationDetails
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 = {}) ⇒ CreateDataGuardAssociationDetails
Initializes the object
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 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 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 160 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.database_software_image_id = attributes[:'databaseSoftwareImageId'] if attributes[:'databaseSoftwareImageId'] raise 'You cannot provide both :databaseSoftwareImageId and :database_software_image_id' if attributes.key?(:'databaseSoftwareImageId') && attributes.key?(:'database_software_image_id') self.database_software_image_id = attributes[:'database_software_image_id'] if attributes[:'database_software_image_id'] self.database_admin_password = attributes[:'databaseAdminPassword'] if attributes[:'databaseAdminPassword'] raise 'You cannot provide both :databaseAdminPassword and :database_admin_password' if attributes.key?(:'databaseAdminPassword') && attributes.key?(:'database_admin_password') self.database_admin_password = attributes[:'database_admin_password'] if attributes[:'database_admin_password'] self.source_encryption_key_location_details = attributes[:'sourceEncryptionKeyLocationDetails'] if attributes[:'sourceEncryptionKeyLocationDetails'] raise 'You cannot provide both :sourceEncryptionKeyLocationDetails and :source_encryption_key_location_details' if attributes.key?(:'sourceEncryptionKeyLocationDetails') && attributes.key?(:'source_encryption_key_location_details') self.source_encryption_key_location_details = attributes[:'source_encryption_key_location_details'] if attributes[:'source_encryption_key_location_details'] self.protection_mode = attributes[:'protectionMode'] if attributes[:'protectionMode'] raise 'You cannot provide both :protectionMode and :protection_mode' if attributes.key?(:'protectionMode') && attributes.key?(:'protection_mode') self.protection_mode = attributes[:'protection_mode'] if attributes[:'protection_mode'] self.transport_type = attributes[:'transportType'] if attributes[:'transportType'] raise 'You cannot provide both :transportType and :transport_type' if attributes.key?(:'transportType') && attributes.key?(:'transport_type') self.transport_type = attributes[:'transport_type'] if attributes[:'transport_type'] self.creation_type = attributes[:'creationType'] if attributes[:'creationType'] raise 'You cannot provide both :creationType and :creation_type' if attributes.key?(:'creationType') && attributes.key?(:'creation_type') self.creation_type = attributes[:'creation_type'] if attributes[:'creation_type'] self.is_active_data_guard_enabled = attributes[:'isActiveDataGuardEnabled'] unless attributes[:'isActiveDataGuardEnabled'].nil? raise 'You cannot provide both :isActiveDataGuardEnabled and :is_active_data_guard_enabled' if attributes.key?(:'isActiveDataGuardEnabled') && attributes.key?(:'is_active_data_guard_enabled') self.is_active_data_guard_enabled = attributes[:'is_active_data_guard_enabled'] unless attributes[:'is_active_data_guard_enabled'].nil? self.peer_db_unique_name = attributes[:'peerDbUniqueName'] if attributes[:'peerDbUniqueName'] raise 'You cannot provide both :peerDbUniqueName and :peer_db_unique_name' if attributes.key?(:'peerDbUniqueName') && attributes.key?(:'peer_db_unique_name') self.peer_db_unique_name = attributes[:'peer_db_unique_name'] if attributes[:'peer_db_unique_name'] self.peer_sid_prefix = attributes[:'peerSidPrefix'] if attributes[:'peerSidPrefix'] raise 'You cannot provide both :peerSidPrefix and :peer_sid_prefix' if attributes.key?(:'peerSidPrefix') && attributes.key?(:'peer_sid_prefix') self.peer_sid_prefix = attributes[:'peer_sid_prefix'] if attributes[:'peer_sid_prefix'] end |
Instance Attribute Details
#creation_type ⇒ String
[Required] Specifies whether to create the peer database in an existing DB system or in a new DB system.
78 79 80 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 78 def creation_type @creation_type end |
#database_admin_password ⇒ String
[Required] A strong password for the SYS
, SYSTEM
, and PDB Admin
users to apply during standby creation.
The password must contain no fewer than nine characters and include:
-
At least two uppercase characters.
-
At least two lowercase characters.
-
At least two numeric characters.
-
At least two special characters. Valid special characters include "_", "#", and "-" only.
The password MUST be the same as the primary admin password.
46 47 48 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 46 def database_admin_password @database_admin_password end |
#database_software_image_id ⇒ String
The database software image OCID
29 30 31 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 29 def database_software_image_id @database_software_image_id end |
#is_active_data_guard_enabled ⇒ BOOLEAN
True if active Data Guard is enabled.
82 83 84 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 82 def is_active_data_guard_enabled @is_active_data_guard_enabled end |
#peer_db_unique_name ⇒ String
Specifies the DB_UNIQUE_NAME
of the peer database to be created.
87 88 89 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 87 def peer_db_unique_name @peer_db_unique_name end |
#peer_sid_prefix ⇒ String
Specifies a prefix for the Oracle SID
of the database to be created.
92 93 94 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 92 def peer_sid_prefix @peer_sid_prefix end |
#protection_mode ⇒ String
[Required] The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.
58 59 60 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 58 def protection_mode @protection_mode end |
#source_encryption_key_location_details ⇒ OCI::Database::Models::EncryptionKeyLocationDetails
49 50 51 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 49 def source_encryption_key_location_details @source_encryption_key_location_details end |
#transport_type ⇒ String
[Required] The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode
:
-
MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
-
MAXIMUM_PERFORMANCE - ASYNC
-
MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
73 74 75 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 73 def transport_type @transport_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 95 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'database_software_image_id': :'databaseSoftwareImageId', 'database_admin_password': :'databaseAdminPassword', 'source_encryption_key_location_details': :'sourceEncryptionKeyLocationDetails', 'protection_mode': :'protectionMode', 'transport_type': :'transportType', 'creation_type': :'creationType', 'is_active_data_guard_enabled': :'isActiveDataGuardEnabled', 'peer_db_unique_name': :'peerDbUniqueName', 'peer_sid_prefix': :'peerSidPrefix' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
133 134 135 136 137 138 139 140 141 142 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 133 def self.get_subtype(object_hash) type = object_hash[:'creationType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Database::Models::CreateDataGuardAssociationWithNewDbSystemDetails' if type == 'NewDbSystem' return 'OCI::Database::Models::CreateDataGuardAssociationToExistingVmClusterDetails' if type == 'ExistingVmCluster' return 'OCI::Database::Models::CreateDataGuardAssociationToExistingDbSystemDetails' if type == 'ExistingDbSystem' # TODO: Log a warning when the subtype is not found. 'OCI::Database::Models::CreateDataGuardAssociationDetails' end |
.swagger_types ⇒ Object
Attribute type mapping.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 112 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'database_software_image_id': :'String', 'database_admin_password': :'String', 'source_encryption_key_location_details': :'OCI::Database::Models::EncryptionKeyLocationDetails', 'protection_mode': :'String', 'transport_type': :'String', 'creation_type': :'String', 'is_active_data_guard_enabled': :'BOOLEAN', 'peer_db_unique_name': :'String', 'peer_sid_prefix': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 244 def ==(other) return true if equal?(other) self.class == other.class && database_software_image_id == other.database_software_image_id && database_admin_password == other.database_admin_password && source_encryption_key_location_details == other.source_encryption_key_location_details && protection_mode == other.protection_mode && transport_type == other.transport_type && creation_type == other.creation_type && is_active_data_guard_enabled == other.is_active_data_guard_enabled && peer_db_unique_name == other.peer_db_unique_name && peer_sid_prefix == other.peer_sid_prefix end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 282 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
262 263 264 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 262 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
271 272 273 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 271 def hash [database_software_image_id, database_admin_password, source_encryption_key_location_details, protection_mode, transport_type, creation_type, is_active_data_guard_enabled, peer_db_unique_name, peer_sid_prefix].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
315 316 317 318 319 320 321 322 323 324 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 315 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
309 310 311 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 309 def to_s to_hash.to_s end |