class OCI::Database::Models::DataGuardAssociation
DataGuardAssociation
model.
Constants
- LIFECYCLE_STATE_ENUM
- PEER_ROLE_ENUM
- PROTECTION_MODE_ENUM
- ROLE_ENUM
- TRANSPORT_TYPE_ENUM
Attributes
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`
@return [String]
The rate at which redo logs are synced between the associated databases.
Example: `180 Mb per second`
@return [String]
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the reporting database. @return [String]
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Data Guard association. @return [String]
Additional information about the current lifecycleState, if available.
@return [String]
[Required] The current state of the Data Guard association. @return [String]
The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the peer database's Data Guard association. @return [String]
The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated peer database. @return [String]
The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Database
Home containing the associated peer database.
@return [String]
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the DB system containing the associated peer database.
@return [String]
[Required] The role of the peer database in this Data Guard association. @return [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.
@return [String]
[Required] The role of the reporting database in this Data Guard association. @return [String]
The date and time the Data Guard association was created. @return [DateTime]
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.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/database/models/data_guard_association.rb, line 127 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'database_id': :'databaseId', 'role': :'role', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'peer_db_system_id': :'peerDbSystemId', 'peer_db_home_id': :'peerDbHomeId', 'peer_database_id': :'peerDatabaseId', 'peer_data_guard_association_id': :'peerDataGuardAssociationId', 'peer_role': :'peerRole', 'apply_lag': :'applyLag', 'apply_rate': :'applyRate', 'protection_mode': :'protectionMode', 'transport_type': :'transportType', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :database_id The value to assign to the {#database_id} property @option attributes [String] :role The value to assign to the {#role} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifecycle_details The value to assign to the {#lifecycle_details} property @option attributes [String] :peer_db_system_id The value to assign to the {#peer_db_system_id} property @option attributes [String] :peer_db_home_id The value to assign to the {#peer_db_home_id} property @option attributes [String] :peer_database_id The value to assign to the {#peer_database_id} property @option attributes [String] :peer_data_guard_association_id The value to assign to the {#peer_data_guard_association_id} property @option attributes [String] :peer_role The value to assign to the {#peer_role} property @option attributes [String] :apply_lag The value to assign to the {#apply_lag} property @option attributes [String] :apply_rate The value to assign to the {#apply_rate} property @option attributes [String] :protection_mode The value to assign to the {#protection_mode} property @option attributes [String] :transport_type The value to assign to the {#transport_type} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
# File lib/oci/database/models/data_guard_association.rb, line 193 def initialize(attributes = {}) return unless attributes.is_a?(Hash) self.id = attributes[:'id'] if attributes[:'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.role = attributes[:'role'] if attributes[:'role'] 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.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.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_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_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_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_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.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.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.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'] end
Attribute type mapping.
# File lib/oci/database/models/data_guard_association.rb, line 150 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'database_id': :'String', 'role': :'String', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'peer_db_system_id': :'String', 'peer_db_home_id': :'String', 'peer_database_id': :'String', 'peer_data_guard_association_id': :'String', 'peer_role': :'String', 'apply_lag': :'String', 'apply_rate': :'String', 'protection_mode': :'String', 'transport_type': :'String', 'time_created': :'DateTime' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/database/models/data_guard_association.rb, line 351 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && database_id == other.database_id && role == other.role && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && peer_db_system_id == other.peer_db_system_id && peer_db_home_id == other.peer_db_home_id && peer_database_id == other.peer_database_id && peer_data_guard_association_id == other.peer_data_guard_association_id && peer_role == other.peer_role && apply_lag == other.apply_lag && apply_rate == other.apply_rate && protection_mode == other.protection_mode && transport_type == other.transport_type && time_created == other.time_created end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/database/models/data_guard_association.rb, line 395 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/database/models/data_guard_association.rb, line 375 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/database/models/data_guard_association.rb, line 384 def hash [id, database_id, role, lifecycle_state, lifecycle_details, peer_db_system_id, peer_db_home_id, peer_database_id, peer_data_guard_association_id, peer_role, apply_lag, apply_rate, protection_mode, transport_type, time_created].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/database/models/data_guard_association.rb, line 296 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] peer_role
Object
to be assigned
# File lib/oci/database/models/data_guard_association.rb, line 309 def peer_role=(peer_role) # rubocop:disable Style/ConditionalAssignment if peer_role && !PEER_ROLE_ENUM.include?(peer_role) OCI.logger.debug("Unknown value for 'peer_role' [" + peer_role + "]. Mapping to 'PEER_ROLE_UNKNOWN_ENUM_VALUE'") if OCI.logger @peer_role = PEER_ROLE_UNKNOWN_ENUM_VALUE else @peer_role = peer_role end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] protection_mode
Object
to be assigned
# File lib/oci/database/models/data_guard_association.rb, line 322 def protection_mode=(protection_mode) # rubocop:disable Style/ConditionalAssignment if protection_mode && !PROTECTION_MODE_ENUM.include?(protection_mode) OCI.logger.debug("Unknown value for 'protection_mode' [" + protection_mode + "]. Mapping to 'PROTECTION_MODE_UNKNOWN_ENUM_VALUE'") if OCI.logger @protection_mode = PROTECTION_MODE_UNKNOWN_ENUM_VALUE else @protection_mode = protection_mode end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] role Object
to be assigned
# File lib/oci/database/models/data_guard_association.rb, line 283 def role=(role) # rubocop:disable Style/ConditionalAssignment if role && !ROLE_ENUM.include?(role) OCI.logger.debug("Unknown value for 'role' [" + role + "]. Mapping to 'ROLE_UNKNOWN_ENUM_VALUE'") if OCI.logger @role = ROLE_UNKNOWN_ENUM_VALUE else @role = role end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/database/models/data_guard_association.rb, line 428 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/database/models/data_guard_association.rb, line 422 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] transport_type
Object
to be assigned
# File lib/oci/database/models/data_guard_association.rb, line 335 def transport_type=(transport_type) # rubocop:disable Style/ConditionalAssignment if transport_type && !TRANSPORT_TYPE_ENUM.include?(transport_type) OCI.logger.debug("Unknown value for 'transport_type' [" + transport_type + "]. Mapping to 'TRANSPORT_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @transport_type = TRANSPORT_TYPE_UNKNOWN_ENUM_VALUE else @transport_type = transport_type end # rubocop:enable Style/ConditionalAssignment end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/database/models/data_guard_association.rb, line 445 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end