Class: OCI::Database::Models::DataGuardAssociationSummary
- Inherits:
-
Object
- Object
- OCI::Database::Models::DataGuardAssociationSummary
- Defined in:
- lib/oci/database/models/data_guard_association_summary.rb
Overview
The properties that define a Data Guard association.
To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
For information about endpoints and signing API requests, see [About the API](docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
rubocop:disable Metrics/LineLength
[ LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- PEER_ROLE_ENUM =
[ PEER_ROLE_PRIMARY = 'PRIMARY'.freeze, PEER_ROLE_STANDBY = 'STANDBY'.freeze, PEER_ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY'.freeze, PEER_ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- PROTECTION_MODE_ENUM =
[ PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY'.freeze, PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE'.freeze, PROTECTION_MODE_MAXIMUM_PROTECTION = 'MAXIMUM_PROTECTION'.freeze, PROTECTION_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- ROLE_ENUM =
[ ROLE_PRIMARY = 'PRIMARY'.freeze, ROLE_STANDBY = 'STANDBY'.freeze, ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY'.freeze, ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- TRANSPORT_TYPE_ENUM =
[ TRANSPORT_TYPE_SYNC = 'SYNC'.freeze, TRANSPORT_TYPE_ASYNC = 'ASYNC'.freeze, TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'.freeze, TRANSPORT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#apply_lag ⇒ String
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database.
-
#apply_rate ⇒ String
The rate at which redo logs are synced between the associated databases.
-
#database_id ⇒ String
[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the reporting database.
-
#id ⇒ String
[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the Data Guard association.
-
#lifecycle_details ⇒ String
Additional information about the current lifecycleState, if available.
-
#lifecycle_state ⇒ String
[Required] The current state of the Data Guard association.
-
#peer_data_guard_association_id ⇒ String
The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the peer database’s Data Guard association.
-
#peer_database_id ⇒ String
The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the associated peer database.
-
#peer_db_home_id ⇒ String
The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the database home containing the associated peer database.
-
#peer_db_system_id ⇒ String
[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the DB System containing the associated peer database.
-
#peer_role ⇒ String
[Required] The role of the peer database in this Data Guard association.
-
#protection_mode ⇒ String
[Required] The protection mode of this Data Guard association.
-
#role ⇒ String
[Required] The role of the reporting database in this Data Guard association.
-
#time_created ⇒ DateTime
The date and time the Data Guard Association was created.
-
#transport_type ⇒ String
The redo transport type used by this Data Guard association.
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 = {}) ⇒ DataGuardAssociationSummary
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 = {}) ⇒ DataGuardAssociationSummary
Initializes the object
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 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 201 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.apply_lag = attributes[:'applyLag'] if attributes[:'applyLag'] raise 'You cannot provide both :applyLag and :apply_lag' if attributes.key?(:'applyLag') && attributes.key?(:'apply_lag') self.apply_lag = attributes[:'apply_lag'] if attributes[:'apply_lag'] self.apply_rate = attributes[:'applyRate'] if attributes[:'applyRate'] raise 'You cannot provide both :applyRate and :apply_rate' if attributes.key?(:'applyRate') && attributes.key?(:'apply_rate') self.apply_rate = attributes[:'apply_rate'] if attributes[:'apply_rate'] 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.id = attributes[:'id'] if attributes[:'id'] self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails'] raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details') self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.peer_data_guard_association_id = attributes[:'peerDataGuardAssociationId'] if attributes[:'peerDataGuardAssociationId'] raise 'You cannot provide both :peerDataGuardAssociationId and :peer_data_guard_association_id' if attributes.key?(:'peerDataGuardAssociationId') && attributes.key?(:'peer_data_guard_association_id') self.peer_data_guard_association_id = attributes[:'peer_data_guard_association_id'] if attributes[:'peer_data_guard_association_id'] self.peer_database_id = attributes[:'peerDatabaseId'] if attributes[:'peerDatabaseId'] raise 'You cannot provide both :peerDatabaseId and :peer_database_id' if attributes.key?(:'peerDatabaseId') && attributes.key?(:'peer_database_id') self.peer_database_id = attributes[:'peer_database_id'] if attributes[:'peer_database_id'] self.peer_db_home_id = attributes[:'peerDbHomeId'] if attributes[:'peerDbHomeId'] raise 'You cannot provide both :peerDbHomeId and :peer_db_home_id' if attributes.key?(:'peerDbHomeId') && attributes.key?(:'peer_db_home_id') self.peer_db_home_id = attributes[:'peer_db_home_id'] if attributes[:'peer_db_home_id'] self.peer_db_system_id = attributes[:'peerDbSystemId'] if attributes[:'peerDbSystemId'] raise 'You cannot provide both :peerDbSystemId and :peer_db_system_id' if attributes.key?(:'peerDbSystemId') && attributes.key?(:'peer_db_system_id') self.peer_db_system_id = attributes[:'peer_db_system_id'] if attributes[:'peer_db_system_id'] self.peer_role = attributes[:'peerRole'] if attributes[:'peerRole'] raise 'You cannot provide both :peerRole and :peer_role' if attributes.key?(:'peerRole') && attributes.key?(:'peer_role') self.peer_role = attributes[:'peer_role'] if attributes[:'peer_role'] 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.role = attributes[:'role'] if attributes[:'role'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] 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'] end |
Instance Attribute Details
#apply_lag ⇒ String
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database.
Example: ‘9 seconds`
63 64 65 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 63 def apply_lag @apply_lag end |
#apply_rate ⇒ String
The rate at which redo logs are synced between the associated databases.
Example: ‘180 Mb per second`
70 71 72 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 70 def apply_rate @apply_rate end |
#database_id ⇒ String
[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the reporting database.
74 75 76 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 74 def database_id @database_id end |
#id ⇒ String
[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the Data Guard association.
78 79 80 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 78 def id @id end |
#lifecycle_details ⇒ String
Additional information about the current lifecycleState, if available.
83 84 85 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 83 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the Data Guard association.
87 88 89 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 87 def lifecycle_state @lifecycle_state end |
#peer_data_guard_association_id ⇒ String
The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the peer database’s Data Guard association.
91 92 93 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 91 def peer_data_guard_association_id @peer_data_guard_association_id end |
#peer_database_id ⇒ String
The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the associated peer database.
95 96 97 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 95 def peer_database_id @peer_database_id end |
#peer_db_home_id ⇒ String
The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the database home containing the associated peer database.
100 101 102 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 100 def peer_db_home_id @peer_db_home_id end |
#peer_db_system_id ⇒ String
[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the DB System containing the associated peer database.
106 107 108 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 106 def peer_db_system_id @peer_db_system_id end |
#peer_role ⇒ String
[Required] The role of the peer database in this Data Guard association.
110 111 112 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 110 def peer_role @peer_role end |
#protection_mode ⇒ String
[Required] The protection mode of this Data Guard association. For more information, see [Oracle Data Guard Protection Modes](docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation.
117 118 119 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 117 def protection_mode @protection_mode end |
#role ⇒ String
[Required] The role of the reporting database in this Data Guard association.
121 122 123 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 121 def role @role end |
#time_created ⇒ DateTime
The date and time the Data Guard Association was created.
125 126 127 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 125 def time_created @time_created end |
#transport_type ⇒ String
The redo transport type used by this Data Guard association. For more information, see [Redo Transport Services](docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation.
132 133 134 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 132 def transport_type @transport_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 135 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'apply_lag': :'applyLag', 'apply_rate': :'applyRate', 'database_id': :'databaseId', 'id': :'id', 'lifecycle_details': :'lifecycleDetails', 'lifecycle_state': :'lifecycleState', 'peer_data_guard_association_id': :'peerDataGuardAssociationId', 'peer_database_id': :'peerDatabaseId', 'peer_db_home_id': :'peerDbHomeId', 'peer_db_system_id': :'peerDbSystemId', 'peer_role': :'peerRole', 'protection_mode': :'protectionMode', 'role': :'role', 'time_created': :'timeCreated', 'transport_type': :'transportType' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 158 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'apply_lag': :'String', 'apply_rate': :'String', 'database_id': :'String', 'id': :'String', 'lifecycle_details': :'String', 'lifecycle_state': :'String', 'peer_data_guard_association_id': :'String', 'peer_database_id': :'String', 'peer_db_home_id': :'String', 'peer_db_system_id': :'String', 'peer_role': :'String', 'protection_mode': :'String', 'role': :'String', 'time_created': :'DateTime', 'transport_type': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 372 def ==(other) return true if equal?(other) self.class == other.class && apply_lag == other.apply_lag && apply_rate == other.apply_rate && database_id == other.database_id && id == other.id && lifecycle_details == other.lifecycle_details && lifecycle_state == other.lifecycle_state && peer_data_guard_association_id == other.peer_data_guard_association_id && peer_database_id == other.peer_database_id && peer_db_home_id == other.peer_db_home_id && peer_db_system_id == other.peer_db_system_id && peer_role == other.peer_role && protection_mode == other.protection_mode && role == other.role && time_created == other.time_created && transport_type == other.transport_type end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 415 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
395 396 397 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 395 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
404 405 406 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 404 def hash [apply_lag, apply_rate, database_id, id, lifecycle_details, lifecycle_state, peer_data_guard_association_id, peer_database_id, peer_db_home_id, peer_db_system_id, peer_role, protection_mode, role, time_created, transport_type].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
447 448 449 450 451 452 453 454 455 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 447 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
441 442 443 |
# File 'lib/oci/database/models/data_guard_association_summary.rb', line 441 def to_s to_hash.to_s end |