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, 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. -
#protection_mode ⇒ String
[Required] The protection mode to set up between the primary and standby databases.
-
#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
122 123 124 125 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 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 122 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_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.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'] 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.
70 71 72 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 70 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.
41 42 43 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 41 def database_admin_password @database_admin_password 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.
50 51 52 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 50 def protection_mode @protection_mode 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.
65 66 67 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 65 def transport_type @transport_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
73 74 75 76 77 78 79 80 81 82 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 73 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'database_admin_password': :'databaseAdminPassword', 'protection_mode': :'protectionMode', 'transport_type': :'transportType', 'creation_type': :'creationType' # 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.
101 102 103 104 105 106 107 108 109 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 101 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::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.
85 86 87 88 89 90 91 92 93 94 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 85 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'database_admin_password': :'String', 'protection_mode': :'String', 'transport_type': :'String', 'creation_type': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
176 177 178 179 180 181 182 183 184 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 176 def ==(other) return true if equal?(other) self.class == other.class && database_admin_password == other.database_admin_password && protection_mode == other.protection_mode && transport_type == other.transport_type && creation_type == other.creation_type end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 209 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
189 190 191 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 189 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
198 199 200 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 198 def hash [database_admin_password, protection_mode, transport_type, creation_type].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
242 243 244 245 246 247 248 249 250 251 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 242 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
236 237 238 |
# File 'lib/oci/database/models/create_data_guard_association_details.rb', line 236 def to_s to_hash.to_s end |