Class: OCI::Recovery::Models::ProtectedDatabaseSummary
- Inherits:
-
Object
- Object
- OCI::Recovery::Models::ProtectedDatabaseSummary
- Defined in:
- lib/oci/recovery/models/protected_database_summary.rb
Overview
A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about access control and compartments, see Overview of the Identity Service.
Constant Summary collapse
- DATABASE_SIZE_ENUM =
[ DATABASE_SIZE_XS = 'XS'.freeze, DATABASE_SIZE_S = 'S'.freeze, DATABASE_SIZE_M = 'M'.freeze, DATABASE_SIZE_L = 'L'.freeze, DATABASE_SIZE_XL = 'XL'.freeze, DATABASE_SIZE_XXL = 'XXL'.freeze, DATABASE_SIZE_AUTO = 'AUTO'.freeze, DATABASE_SIZE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETE_SCHEDULED = 'DELETE_SCHEDULED'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- HEALTH_ENUM =
[ HEALTH_PROTECTED = 'PROTECTED'.freeze, HEALTH_WARNING = 'WARNING'.freeze, HEALTH_ALERT = 'ALERT'.freeze, HEALTH_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the protected database.
-
#database_id ⇒ String
The OCID of the protected database.
-
#database_size ⇒ String
[Required] The size of the protected database.
-
#db_unique_name ⇒ String
[Required] The dbUniqueName for the protected database in Recovery Service.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
The protected database name.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#health ⇒ String
The health of the Protected Database.
-
#health_details ⇒ String
A message describing the current health of the protected database.
-
#id ⇒ String
[Required] The OCID of the protected database.
-
#is_read_only_resource ⇒ BOOLEAN
Indicates whether the protected database is created by Recovery Service or created manually.
-
#lifecycle_details ⇒ String
Detailed description about the current lifecycle state of the protected database.
-
#lifecycle_state ⇒ String
The current state of the Protected Database.
- #metrics ⇒ OCI::Recovery::Models::MetricsSummary
-
#policy_locked_date_time ⇒ String
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
-
#protection_policy_id ⇒ String
[Required] The OCID of the protection policy associated with the protected database.
-
#recovery_service_subnets ⇒ Array<OCI::Recovery::Models::RecoveryServiceSubnetDetails>
List of recovery service subnet resources associated with the protected database.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
An RFC3339 formatted datetime string that indicates the created time for a protected database.
-
#time_updated ⇒ DateTime
An RFC3339 formatted datetime string that indicates the last updated time for a protected database.
-
#vpc_user_name ⇒ String
[Required] The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
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 = {}) ⇒ ProtectedDatabaseSummary
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 = {}) ⇒ ProtectedDatabaseSummary
Initializes the object
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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 231 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.id = attributes[:'id'] if attributes[:'id'] 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.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.db_unique_name = attributes[:'dbUniqueName'] if attributes[:'dbUniqueName'] raise 'You cannot provide both :dbUniqueName and :db_unique_name' if attributes.key?(:'dbUniqueName') && attributes.key?(:'db_unique_name') self.db_unique_name = attributes[:'db_unique_name'] if attributes[:'db_unique_name'] self.vpc_user_name = attributes[:'vpcUserName'] if attributes[:'vpcUserName'] raise 'You cannot provide both :vpcUserName and :vpc_user_name' if attributes.key?(:'vpcUserName') && attributes.key?(:'vpc_user_name') self.vpc_user_name = attributes[:'vpc_user_name'] if attributes[:'vpc_user_name'] self.database_size = attributes[:'databaseSize'] if attributes[:'databaseSize'] raise 'You cannot provide both :databaseSize and :database_size' if attributes.key?(:'databaseSize') && attributes.key?(:'database_size') self.database_size = attributes[:'database_size'] if attributes[:'database_size'] self.protection_policy_id = attributes[:'protectionPolicyId'] if attributes[:'protectionPolicyId'] raise 'You cannot provide both :protectionPolicyId and :protection_policy_id' if attributes.key?(:'protectionPolicyId') && attributes.key?(:'protection_policy_id') self.protection_policy_id = attributes[:'protection_policy_id'] if attributes[:'protection_policy_id'] self.policy_locked_date_time = attributes[:'policyLockedDateTime'] if attributes[:'policyLockedDateTime'] raise 'You cannot provide both :policyLockedDateTime and :policy_locked_date_time' if attributes.key?(:'policyLockedDateTime') && attributes.key?(:'policy_locked_date_time') self.policy_locked_date_time = attributes[:'policy_locked_date_time'] if attributes[:'policy_locked_date_time'] self.recovery_service_subnets = attributes[:'recoveryServiceSubnets'] if attributes[:'recoveryServiceSubnets'] raise 'You cannot provide both :recoveryServiceSubnets and :recovery_service_subnets' if attributes.key?(:'recoveryServiceSubnets') && attributes.key?(:'recovery_service_subnets') self.recovery_service_subnets = attributes[:'recovery_service_subnets'] if attributes[:'recovery_service_subnets'] 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.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.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] 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.health = attributes[:'health'] if attributes[:'health'] 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.health_details = attributes[:'healthDetails'] if attributes[:'healthDetails'] raise 'You cannot provide both :healthDetails and :health_details' if attributes.key?(:'healthDetails') && attributes.key?(:'health_details') self.health_details = attributes[:'health_details'] if attributes[:'health_details'] self.is_read_only_resource = attributes[:'isReadOnlyResource'] unless attributes[:'isReadOnlyResource'].nil? raise 'You cannot provide both :isReadOnlyResource and :is_read_only_resource' if attributes.key?(:'isReadOnlyResource') && attributes.key?(:'is_read_only_resource') self.is_read_only_resource = attributes[:'is_read_only_resource'] unless attributes[:'is_read_only_resource'].nil? self.metrics = attributes[:'metrics'] if attributes[:'metrics'] 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. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the protected database.
58 59 60 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 58 def compartment_id @compartment_id end |
#database_id ⇒ String
The OCID of the protected database.
90 91 92 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 90 def database_id @database_id end |
#database_size ⇒ String
[Required] The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
70 71 72 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 70 def database_size @database_size end |
#db_unique_name ⇒ String
[Required] The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
62 63 64 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 62 def db_unique_name @db_unique_name end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}. For more information, see {Resource Tags}[https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm]
138 139 140 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 138 def @defined_tags end |
#display_name ⇒ String
The protected database name. You can change the displayName. Avoid entering confidential information.
54 55 56 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 54 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
132 133 134 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 132 def @freeform_tags end |
#health ⇒ String
The health of the Protected Database.
108 109 110 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 108 def health @health end |
#health_details ⇒ String
A message describing the current health of the protected database.
116 117 118 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 116 def health_details @health_details end |
#id ⇒ String
[Required] The OCID of the protected database.
50 51 52 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 50 def id @id end |
#is_read_only_resource ⇒ BOOLEAN
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
123 124 125 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 123 def is_read_only_resource @is_read_only_resource end |
#lifecycle_details ⇒ String
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
112 113 114 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 112 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the Protected Database.
104 105 106 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 104 def lifecycle_state @lifecycle_state end |
#metrics ⇒ OCI::Recovery::Models::MetricsSummary
126 127 128 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 126 def metrics @metrics end |
#policy_locked_date_time ⇒ String
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect.
82 83 84 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 82 def policy_locked_date_time @policy_locked_date_time end |
#protection_policy_id ⇒ String
[Required] The OCID of the protection policy associated with the protected database.
74 75 76 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 74 def protection_policy_id @protection_policy_id end |
#recovery_service_subnets ⇒ Array<OCI::Recovery::Models::RecoveryServiceSubnetDetails>
List of recovery service subnet resources associated with the protected database.
86 87 88 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 86 def recovery_service_subnets @recovery_service_subnets end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}. For more information, see {Resource Tags}[https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm]
144 145 146 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 144 def @system_tags end |
#time_created ⇒ DateTime
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
95 96 97 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 95 def time_created @time_created end |
#time_updated ⇒ DateTime
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
100 101 102 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 100 def time_updated @time_updated end |
#vpc_user_name ⇒ String
[Required] The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
66 67 68 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 66 def vpc_user_name @vpc_user_name end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 147 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'db_unique_name': :'dbUniqueName', 'vpc_user_name': :'vpcUserName', 'database_size': :'databaseSize', 'protection_policy_id': :'protectionPolicyId', 'policy_locked_date_time': :'policyLockedDateTime', 'recovery_service_subnets': :'recoveryServiceSubnets', 'database_id': :'databaseId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'health': :'health', 'lifecycle_details': :'lifecycleDetails', 'health_details': :'healthDetails', 'is_read_only_resource': :'isReadOnlyResource', 'metrics': :'metrics', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 176 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'db_unique_name': :'String', 'vpc_user_name': :'String', 'database_size': :'String', 'protection_policy_id': :'String', 'policy_locked_date_time': :'String', 'recovery_service_subnets': :'Array<OCI::Recovery::Models::RecoveryServiceSubnetDetails>', 'database_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'health': :'String', 'lifecycle_details': :'String', 'health_details': :'String', 'is_read_only_resource': :'BOOLEAN', 'metrics': :'OCI::Recovery::Models::MetricsSummary', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 398 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && db_unique_name == other.db_unique_name && vpc_user_name == other.vpc_user_name && database_size == other.database_size && protection_policy_id == other.protection_policy_id && policy_locked_date_time == other.policy_locked_date_time && recovery_service_subnets == other.recovery_service_subnets && database_id == other.database_id && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && health == other.health && lifecycle_details == other.lifecycle_details && health_details == other.health_details && is_read_only_resource == other.is_read_only_resource && metrics == other.metrics && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 448 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
428 429 430 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 428 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
437 438 439 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 437 def hash [id, display_name, compartment_id, db_unique_name, vpc_user_name, database_size, protection_policy_id, policy_locked_date_time, recovery_service_subnets, database_id, time_created, time_updated, lifecycle_state, health, lifecycle_details, health_details, is_read_only_resource, metrics, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
481 482 483 484 485 486 487 488 489 490 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 481 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
475 476 477 |
# File 'lib/oci/recovery/models/protected_database_summary.rb', line 475 def to_s to_hash.to_s end |