Class: OCI::Database::Models::AutonomousDatabaseBackup
- Inherits:
-
Object
- Object
- OCI::Database::Models::AutonomousDatabaseBackup
- Defined in:
- lib/oci/database/models/autonomous_database_backup.rb
Overview
An Autonomous Database backup.
Constant Summary collapse
- TYPE_ENUM =
[ TYPE_INCREMENTAL = 'INCREMENTAL'.freeze, TYPE_FULL = 'FULL'.freeze, TYPE_LONGTERM = 'LONGTERM'.freeze, TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#autonomous_database_id ⇒ String
[Required] The OCID of the Autonomous Database.
- #backup_destination_details ⇒ OCI::Database::Models::BackupDestinationDetails
-
#compartment_id ⇒ String
[Required] The OCID of the compartment.
-
#database_size_in_tbs ⇒ Float
The size of the database in terabytes at the time the backup was taken.
-
#db_version ⇒ String
A valid Oracle Database version for Autonomous Database.
-
#display_name ⇒ String
[Required] The user-friendly name for the backup.
-
#id ⇒ String
[Required] The OCID of the Autonomous Database backup.
-
#is_automatic ⇒ BOOLEAN
[Required] Indicates whether the backup is user-initiated or automatic.
-
#is_restorable ⇒ BOOLEAN
Indicates whether the backup can be used to restore the associated Autonomous Database.
-
#key_store_id ⇒ String
The OCID of the key store of Oracle Vault.
-
#key_store_wallet_name ⇒ String
The wallet name for Oracle Key Vault.
-
#kms_key_id ⇒ String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
-
#kms_key_version_id ⇒ String
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
-
#lifecycle_details ⇒ String
Additional information about the current lifecycle state.
-
#lifecycle_state ⇒ String
[Required] The current state of the backup.
-
#retention_period_in_days ⇒ Integer
Retention period, in days, for long-term backups.
-
#size_in_tbs ⇒ Float
The backup size in terrabytes (TB).
-
#time_available_till ⇒ DateTime
Timestamp until when the backup will be available.
-
#time_ended ⇒ DateTime
The date and time the backup completed.
-
#time_started ⇒ DateTime
The date and time the backup started.
-
#type ⇒ String
[Required] The type of backup.
- #vault_id ⇒ String
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 = {}) ⇒ AutonomousDatabaseBackup
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 = {}) ⇒ AutonomousDatabaseBackup
Initializes the object
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 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 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 207 def initialize(attributes = {}) return unless attributes.is_a?(Hash) self.id = attributes[:'id'] if attributes[:'id'] 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.autonomous_database_id = attributes[:'autonomousDatabaseId'] if attributes[:'autonomousDatabaseId'] raise 'You cannot provide both :autonomousDatabaseId and :autonomous_database_id' if attributes.key?(:'autonomousDatabaseId') && attributes.key?(:'autonomous_database_id') self.autonomous_database_id = attributes[:'autonomous_database_id'] if attributes[:'autonomous_database_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.type = attributes[:'type'] if attributes[:'type'] self.is_automatic = attributes[:'isAutomatic'] unless attributes[:'isAutomatic'].nil? raise 'You cannot provide both :isAutomatic and :is_automatic' if attributes.key?(:'isAutomatic') && attributes.key?(:'is_automatic') self.is_automatic = attributes[:'is_automatic'] unless attributes[:'is_automatic'].nil? self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted'] raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started') self.time_started = attributes[:'time_started'] if attributes[:'time_started'] self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded'] raise 'You cannot provide both :timeEnded and :time_ended' if attributes.key?(:'timeEnded') && attributes.key?(:'time_ended') self.time_ended = attributes[:'time_ended'] if attributes[:'time_ended'] 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.database_size_in_tbs = attributes[:'databaseSizeInTBs'] if attributes[:'databaseSizeInTBs'] raise 'You cannot provide both :databaseSizeInTBs and :database_size_in_tbs' if attributes.key?(:'databaseSizeInTBs') && attributes.key?(:'database_size_in_tbs') self.database_size_in_tbs = attributes[:'database_size_in_tbs'] if attributes[:'database_size_in_tbs'] 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.is_restorable = attributes[:'isRestorable'] unless attributes[:'isRestorable'].nil? self.is_restorable = true if is_restorable.nil? && !attributes.key?(:'isRestorable') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isRestorable and :is_restorable' if attributes.key?(:'isRestorable') && attributes.key?(:'is_restorable') self.is_restorable = attributes[:'is_restorable'] unless attributes[:'is_restorable'].nil? self.is_restorable = true if is_restorable.nil? && !attributes.key?(:'isRestorable') && !attributes.key?(:'is_restorable') # rubocop:disable Style/StringLiterals self.key_store_id = attributes[:'keyStoreId'] if attributes[:'keyStoreId'] raise 'You cannot provide both :keyStoreId and :key_store_id' if attributes.key?(:'keyStoreId') && attributes.key?(:'key_store_id') self.key_store_id = attributes[:'key_store_id'] if attributes[:'key_store_id'] self.key_store_wallet_name = attributes[:'keyStoreWalletName'] if attributes[:'keyStoreWalletName'] raise 'You cannot provide both :keyStoreWalletName and :key_store_wallet_name' if attributes.key?(:'keyStoreWalletName') && attributes.key?(:'key_store_wallet_name') self.key_store_wallet_name = attributes[:'key_store_wallet_name'] if attributes[:'key_store_wallet_name'] self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId'] raise 'You cannot provide both :kmsKeyId and :kms_key_id' if attributes.key?(:'kmsKeyId') && attributes.key?(:'kms_key_id') self.kms_key_id = attributes[:'kms_key_id'] if attributes[:'kms_key_id'] self.vault_id = attributes[:'vaultId'] if attributes[:'vaultId'] raise 'You cannot provide both :vaultId and :vault_id' if attributes.key?(:'vaultId') && attributes.key?(:'vault_id') self.vault_id = attributes[:'vault_id'] if attributes[:'vault_id'] self.kms_key_version_id = attributes[:'kmsKeyVersionId'] if attributes[:'kmsKeyVersionId'] raise 'You cannot provide both :kmsKeyVersionId and :kms_key_version_id' if attributes.key?(:'kmsKeyVersionId') && attributes.key?(:'kms_key_version_id') self.kms_key_version_id = attributes[:'kms_key_version_id'] if attributes[:'kms_key_version_id'] self.retention_period_in_days = attributes[:'retentionPeriodInDays'] if attributes[:'retentionPeriodInDays'] raise 'You cannot provide both :retentionPeriodInDays and :retention_period_in_days' if attributes.key?(:'retentionPeriodInDays') && attributes.key?(:'retention_period_in_days') self.retention_period_in_days = attributes[:'retention_period_in_days'] if attributes[:'retention_period_in_days'] self.time_available_till = attributes[:'timeAvailableTill'] if attributes[:'timeAvailableTill'] raise 'You cannot provide both :timeAvailableTill and :time_available_till' if attributes.key?(:'timeAvailableTill') && attributes.key?(:'time_available_till') self.time_available_till = attributes[:'time_available_till'] if attributes[:'time_available_till'] self.db_version = attributes[:'dbVersion'] if attributes[:'dbVersion'] raise 'You cannot provide both :dbVersion and :db_version' if attributes.key?(:'dbVersion') && attributes.key?(:'db_version') self.db_version = attributes[:'db_version'] if attributes[:'db_version'] self.size_in_tbs = attributes[:'sizeInTBs'] if attributes[:'sizeInTBs'] raise 'You cannot provide both :sizeInTBs and :size_in_tbs' if attributes.key?(:'sizeInTBs') && attributes.key?(:'size_in_tbs') self.size_in_tbs = attributes[:'size_in_tbs'] if attributes[:'size_in_tbs'] self.backup_destination_details = attributes[:'backupDestinationDetails'] if attributes[:'backupDestinationDetails'] raise 'You cannot provide both :backupDestinationDetails and :backup_destination_details' if attributes.key?(:'backupDestinationDetails') && attributes.key?(:'backup_destination_details') self.backup_destination_details = attributes[:'backup_destination_details'] if attributes[:'backup_destination_details'] end |
Instance Attribute Details
#autonomous_database_id ⇒ String
[Required] The OCID of the Autonomous Database.
40 41 42 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 40 def autonomous_database_id @autonomous_database_id end |
#backup_destination_details ⇒ OCI::Database::Models::BackupDestinationDetails
117 118 119 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 117 def backup_destination_details @backup_destination_details end |
#compartment_id ⇒ String
[Required] The OCID of the compartment.
36 37 38 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 36 def compartment_id @compartment_id end |
#database_size_in_tbs ⇒ Float
The size of the database in terabytes at the time the backup was taken.
69 70 71 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 69 def database_size_in_tbs @database_size_in_tbs end |
#db_version ⇒ String
A valid Oracle Database version for Autonomous Database.
110 111 112 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 110 def db_version @db_version end |
#display_name ⇒ String
[Required] The user-friendly name for the backup. The name does not have to be unique.
44 45 46 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 44 def display_name @display_name end |
#id ⇒ String
[Required] The OCID of the Autonomous Database backup.
32 33 34 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 32 def id @id end |
#is_automatic ⇒ BOOLEAN
[Required] Indicates whether the backup is user-initiated or automatic.
52 53 54 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 52 def is_automatic @is_automatic end |
#is_restorable ⇒ BOOLEAN
Indicates whether the backup can be used to restore the associated Autonomous Database.
77 78 79 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 77 def is_restorable @is_restorable end |
#key_store_id ⇒ String
The OCID of the key store of Oracle Vault.
81 82 83 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 81 def key_store_id @key_store_id end |
#key_store_wallet_name ⇒ String
The wallet name for Oracle Key Vault.
85 86 87 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 85 def key_store_wallet_name @key_store_wallet_name end |
#kms_key_id ⇒ String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
89 90 91 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 89 def kms_key_id @kms_key_id end |
#kms_key_version_id ⇒ String
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
98 99 100 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 98 def kms_key_version_id @kms_key_version_id end |
#lifecycle_details ⇒ String
Additional information about the current lifecycle state.
64 65 66 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 64 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the backup.
73 74 75 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 73 def lifecycle_state @lifecycle_state end |
#retention_period_in_days ⇒ Integer
Retention period, in days, for long-term backups
102 103 104 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 102 def retention_period_in_days @retention_period_in_days end |
#size_in_tbs ⇒ Float
The backup size in terrabytes (TB).
114 115 116 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 114 def size_in_tbs @size_in_tbs end |
#time_available_till ⇒ DateTime
Timestamp until when the backup will be available
106 107 108 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 106 def time_available_till @time_available_till end |
#time_ended ⇒ DateTime
The date and time the backup completed.
60 61 62 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 60 def time_ended @time_ended end |
#time_started ⇒ DateTime
The date and time the backup started.
56 57 58 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 56 def time_started @time_started end |
#type ⇒ String
[Required] The type of backup.
48 49 50 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 48 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
120 121 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 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 120 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'autonomous_database_id': :'autonomousDatabaseId', 'display_name': :'displayName', 'type': :'type', 'is_automatic': :'isAutomatic', 'time_started': :'timeStarted', 'time_ended': :'timeEnded', 'lifecycle_details': :'lifecycleDetails', 'database_size_in_tbs': :'databaseSizeInTBs', 'lifecycle_state': :'lifecycleState', 'is_restorable': :'isRestorable', 'key_store_id': :'keyStoreId', 'key_store_wallet_name': :'keyStoreWalletName', 'kms_key_id': :'kmsKeyId', 'vault_id': :'vaultId', 'kms_key_version_id': :'kmsKeyVersionId', 'retention_period_in_days': :'retentionPeriodInDays', 'time_available_till': :'timeAvailableTill', 'db_version': :'dbVersion', 'size_in_tbs': :'sizeInTBs', 'backup_destination_details': :'backupDestinationDetails' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 150 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'autonomous_database_id': :'String', 'display_name': :'String', 'type': :'String', 'is_automatic': :'BOOLEAN', 'time_started': :'DateTime', 'time_ended': :'DateTime', 'lifecycle_details': :'String', 'database_size_in_tbs': :'Float', 'lifecycle_state': :'String', 'is_restorable': :'BOOLEAN', 'key_store_id': :'String', 'key_store_wallet_name': :'String', 'kms_key_id': :'String', 'vault_id': :'String', 'kms_key_version_id': :'String', 'retention_period_in_days': :'Integer', 'time_available_till': :'DateTime', 'db_version': :'String', 'size_in_tbs': :'Float', 'backup_destination_details': :'OCI::Database::Models::BackupDestinationDetails' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 370 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && autonomous_database_id == other.autonomous_database_id && display_name == other.display_name && type == other.type && is_automatic == other.is_automatic && time_started == other.time_started && time_ended == other.time_ended && lifecycle_details == other.lifecycle_details && database_size_in_tbs == other.database_size_in_tbs && lifecycle_state == other.lifecycle_state && is_restorable == other.is_restorable && key_store_id == other.key_store_id && key_store_wallet_name == other.key_store_wallet_name && kms_key_id == other.kms_key_id && vault_id == other.vault_id && kms_key_version_id == other.kms_key_version_id && retention_period_in_days == other.retention_period_in_days && time_available_till == other.time_available_till && db_version == other.db_version && size_in_tbs == other.size_in_tbs && backup_destination_details == other.backup_destination_details end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 421 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
401 402 403 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 401 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
410 411 412 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 410 def hash [id, compartment_id, autonomous_database_id, display_name, type, is_automatic, time_started, time_ended, lifecycle_details, database_size_in_tbs, lifecycle_state, is_restorable, key_store_id, key_store_wallet_name, kms_key_id, vault_id, kms_key_version_id, retention_period_in_days, time_available_till, db_version, size_in_tbs, backup_destination_details].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
454 455 456 457 458 459 460 461 462 463 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 454 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
448 449 450 |
# File 'lib/oci/database/models/autonomous_database_backup.rb', line 448 def to_s to_hash.to_s end |