Class: OCI::Mysql::Models::Backup
- Inherits:
-
Object
- Object
- OCI::Mysql::Models::Backup
- Defined in:
- lib/oci/mysql/models/backup.rb
Overview
A full or incremental copy of a DB System which can be used to create a new DB System or recover a DB System.
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.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.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
- BACKUP_TYPE_ENUM =
[ BACKUP_TYPE_FULL = 'FULL'.freeze, BACKUP_TYPE_INCREMENTAL = 'INCREMENTAL'.freeze, BACKUP_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- CREATION_TYPE_ENUM =
[ CREATION_TYPE_MANUAL = 'MANUAL'.freeze, CREATION_TYPE_AUTOMATIC = 'AUTOMATIC'.freeze, CREATION_TYPE_OPERATOR = 'OPERATOR'.freeze, CREATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#backup_size_in_gbs ⇒ Integer
The size of the backup in base-2 (IEC) gibibytes.
-
#backup_type ⇒ String
[Required] The type of backup.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment.
-
#creation_type ⇒ String
[Required] Indicates how the backup was created: manually, automatic, or by an Operator.
-
#data_storage_size_in_gbs ⇒ Integer
Initial size of the data volume in GiBs.
-
#db_system_id ⇒ String
[Required] The OCID of the DB System the backup is associated with.
- #db_system_snapshot ⇒ OCI::Mysql::Models::DbSystemSnapshot
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
A user-supplied description for the backup.
-
#display_name ⇒ String
A user-supplied display name for the backup.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] OCID of the backup itself.
-
#immediate_source_backup_id ⇒ String
The OCID of the immediate source DB system backup from which this DB system backup was copied.
-
#lifecycle_details ⇒ String
[Required] Additional information about the current lifecycleState.
-
#lifecycle_state ⇒ String
[Required] The state of the backup.
-
#mysql_version ⇒ String
The MySQL server version of the DB System used for backup.
-
#original_source_backup_id ⇒ String
The OCID of the original source DB system backup from which this DB system backup was copied.
-
#retention_in_days ⇒ Integer
Number of days to retain this backup.
-
#shape_name ⇒ String
The shape of the DB System used for backup.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_copy_created ⇒ DateTime
The date and time the DB system backup copy was created, as described by RFC 3339.
-
#time_created ⇒ DateTime
[Required] The time the backup record was created.
-
#time_updated ⇒ DateTime
[Required] The time at which the backup was updated.
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 = {}) ⇒ Backup
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 = {}) ⇒ Backup
Initializes the object
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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/oci/mysql/models/backup.rb', line 237 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.description = attributes[:'description'] if attributes[:'description'] 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.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.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.backup_type = attributes[:'backupType'] if attributes[:'backupType'] raise 'You cannot provide both :backupType and :backup_type' if attributes.key?(:'backupType') && attributes.key?(:'backup_type') self.backup_type = attributes[:'backup_type'] if attributes[:'backup_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'] self.db_system_id = attributes[:'dbSystemId'] if attributes[:'dbSystemId'] raise 'You cannot provide both :dbSystemId and :db_system_id' if attributes.key?(:'dbSystemId') && attributes.key?(:'db_system_id') self.db_system_id = attributes[:'db_system_id'] if attributes[:'db_system_id'] self.db_system_snapshot = attributes[:'dbSystemSnapshot'] if attributes[:'dbSystemSnapshot'] raise 'You cannot provide both :dbSystemSnapshot and :db_system_snapshot' if attributes.key?(:'dbSystemSnapshot') && attributes.key?(:'db_system_snapshot') self.db_system_snapshot = attributes[:'db_system_snapshot'] if attributes[:'db_system_snapshot'] self.backup_size_in_gbs = attributes[:'backupSizeInGBs'] if attributes[:'backupSizeInGBs'] raise 'You cannot provide both :backupSizeInGBs and :backup_size_in_gbs' if attributes.key?(:'backupSizeInGBs') && attributes.key?(:'backup_size_in_gbs') self.backup_size_in_gbs = attributes[:'backup_size_in_gbs'] if attributes[:'backup_size_in_gbs'] self.retention_in_days = attributes[:'retentionInDays'] if attributes[:'retentionInDays'] raise 'You cannot provide both :retentionInDays and :retention_in_days' if attributes.key?(:'retentionInDays') && attributes.key?(:'retention_in_days') self.retention_in_days = attributes[:'retention_in_days'] if attributes[:'retention_in_days'] self.data_storage_size_in_gbs = attributes[:'dataStorageSizeInGBs'] if attributes[:'dataStorageSizeInGBs'] raise 'You cannot provide both :dataStorageSizeInGBs and :data_storage_size_in_gbs' if attributes.key?(:'dataStorageSizeInGBs') && attributes.key?(:'data_storage_size_in_gbs') self.data_storage_size_in_gbs = attributes[:'data_storage_size_in_gbs'] if attributes[:'data_storage_size_in_gbs'] self.mysql_version = attributes[:'mysqlVersion'] if attributes[:'mysqlVersion'] raise 'You cannot provide both :mysqlVersion and :mysql_version' if attributes.key?(:'mysqlVersion') && attributes.key?(:'mysql_version') self.mysql_version = attributes[:'mysql_version'] if attributes[:'mysql_version'] self.shape_name = attributes[:'shapeName'] if attributes[:'shapeName'] raise 'You cannot provide both :shapeName and :shape_name' if attributes.key?(:'shapeName') && attributes.key?(:'shape_name') self.shape_name = attributes[:'shape_name'] if attributes[:'shape_name'] 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'] self.immediate_source_backup_id = attributes[:'immediateSourceBackupId'] if attributes[:'immediateSourceBackupId'] raise 'You cannot provide both :immediateSourceBackupId and :immediate_source_backup_id' if attributes.key?(:'immediateSourceBackupId') && attributes.key?(:'immediate_source_backup_id') self.immediate_source_backup_id = attributes[:'immediate_source_backup_id'] if attributes[:'immediate_source_backup_id'] self.original_source_backup_id = attributes[:'originalSourceBackupId'] if attributes[:'originalSourceBackupId'] raise 'You cannot provide both :originalSourceBackupId and :original_source_backup_id' if attributes.key?(:'originalSourceBackupId') && attributes.key?(:'original_source_backup_id') self.original_source_backup_id = attributes[:'original_source_backup_id'] if attributes[:'original_source_backup_id'] self.time_copy_created = attributes[:'timeCopyCreated'] if attributes[:'timeCopyCreated'] raise 'You cannot provide both :timeCopyCreated and :time_copy_created' if attributes.key?(:'timeCopyCreated') && attributes.key?(:'time_copy_created') self.time_copy_created = attributes[:'time_copy_created'] if attributes[:'time_copy_created'] end |
Instance Attribute Details
#backup_size_in_gbs ⇒ Integer
The size of the backup in base-2 (IEC) gibibytes. (GiB).
94 95 96 |
# File 'lib/oci/mysql/models/backup.rb', line 94 def backup_size_in_gbs @backup_size_in_gbs end |
#backup_type ⇒ String
[Required] The type of backup.
78 79 80 |
# File 'lib/oci/mysql/models/backup.rb', line 78 def backup_type @backup_type end |
#compartment_id ⇒ String
[Required] The OCID of the compartment.
58 59 60 |
# File 'lib/oci/mysql/models/backup.rb', line 58 def compartment_id @compartment_id end |
#creation_type ⇒ String
[Required] Indicates how the backup was created: manually, automatic, or by an Operator.
83 84 85 |
# File 'lib/oci/mysql/models/backup.rb', line 83 def creation_type @creation_type end |
#data_storage_size_in_gbs ⇒ Integer
Initial size of the data volume in GiBs.
103 104 105 |
# File 'lib/oci/mysql/models/backup.rb', line 103 def data_storage_size_in_gbs @data_storage_size_in_gbs end |
#db_system_id ⇒ String
[Required] The OCID of the DB System the backup is associated with.
87 88 89 |
# File 'lib/oci/mysql/models/backup.rb', line 87 def db_system_id @db_system_id end |
#db_system_snapshot ⇒ OCI::Mysql::Models::DbSystemSnapshot
90 91 92 |
# File 'lib/oci/mysql/models/backup.rb', line 90 def db_system_snapshot @db_system_snapshot 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\"}}
123 124 125 |
# File 'lib/oci/mysql/models/backup.rb', line 123 def @defined_tags end |
#description ⇒ String
A user-supplied description for the backup.
54 55 56 |
# File 'lib/oci/mysql/models/backup.rb', line 54 def description @description end |
#display_name ⇒ String
A user-supplied display name for the backup.
50 51 52 |
# File 'lib/oci/mysql/models/backup.rb', line 50 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\"}
117 118 119 |
# File 'lib/oci/mysql/models/backup.rb', line 117 def @freeform_tags end |
#id ⇒ String
[Required] OCID of the backup itself
46 47 48 |
# File 'lib/oci/mysql/models/backup.rb', line 46 def id @id end |
#immediate_source_backup_id ⇒ String
The OCID of the immediate source DB system backup from which this DB system backup was copied.
134 135 136 |
# File 'lib/oci/mysql/models/backup.rb', line 134 def immediate_source_backup_id @immediate_source_backup_id end |
#lifecycle_details ⇒ String
[Required] Additional information about the current lifecycleState.
74 75 76 |
# File 'lib/oci/mysql/models/backup.rb', line 74 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The state of the backup.
70 71 72 |
# File 'lib/oci/mysql/models/backup.rb', line 70 def lifecycle_state @lifecycle_state end |
#mysql_version ⇒ String
The MySQL server version of the DB System used for backup.
107 108 109 |
# File 'lib/oci/mysql/models/backup.rb', line 107 def mysql_version @mysql_version end |
#original_source_backup_id ⇒ String
The OCID of the original source DB system backup from which this DB system backup was copied.
139 140 141 |
# File 'lib/oci/mysql/models/backup.rb', line 139 def original_source_backup_id @original_source_backup_id end |
#retention_in_days ⇒ Integer
Number of days to retain this backup.
98 99 100 |
# File 'lib/oci/mysql/models/backup.rb', line 98 def retention_in_days @retention_in_days end |
#shape_name ⇒ String
The shape of the DB System used for backup.
111 112 113 |
# File 'lib/oci/mysql/models/backup.rb', line 111 def shape_name @shape_name 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\"}}
129 130 131 |
# File 'lib/oci/mysql/models/backup.rb', line 129 def @system_tags end |
#time_copy_created ⇒ DateTime
The date and time the DB system backup copy was created, as described by RFC 3339.
144 145 146 |
# File 'lib/oci/mysql/models/backup.rb', line 144 def time_copy_created @time_copy_created end |
#time_created ⇒ DateTime
[Required] The time the backup record was created.
62 63 64 |
# File 'lib/oci/mysql/models/backup.rb', line 62 def time_created @time_created end |
#time_updated ⇒ DateTime
[Required] The time at which the backup was updated.
66 67 68 |
# File 'lib/oci/mysql/models/backup.rb', line 66 def time_updated @time_updated 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 174 175 |
# File 'lib/oci/mysql/models/backup.rb', line 147 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'description': :'description', 'compartment_id': :'compartmentId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'backup_type': :'backupType', 'creation_type': :'creationType', 'db_system_id': :'dbSystemId', 'db_system_snapshot': :'dbSystemSnapshot', 'backup_size_in_gbs': :'backupSizeInGBs', 'retention_in_days': :'retentionInDays', 'data_storage_size_in_gbs': :'dataStorageSizeInGBs', 'mysql_version': :'mysqlVersion', 'shape_name': :'shapeName', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags', 'immediate_source_backup_id': :'immediateSourceBackupId', 'original_source_backup_id': :'originalSourceBackupId', 'time_copy_created': :'timeCopyCreated' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 203 204 205 206 |
# File 'lib/oci/mysql/models/backup.rb', line 178 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'description': :'String', 'compartment_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'backup_type': :'String', 'creation_type': :'String', 'db_system_id': :'String', 'db_system_snapshot': :'OCI::Mysql::Models::DbSystemSnapshot', 'backup_size_in_gbs': :'Integer', 'retention_in_days': :'Integer', 'data_storage_size_in_gbs': :'Integer', 'mysql_version': :'String', 'shape_name': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>', 'immediate_source_backup_id': :'String', 'original_source_backup_id': :'String', 'time_copy_created': :'DateTime' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 |
# File 'lib/oci/mysql/models/backup.rb', line 420 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && description == other.description && compartment_id == other.compartment_id && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && backup_type == other.backup_type && creation_type == other.creation_type && db_system_id == other.db_system_id && db_system_snapshot == other.db_system_snapshot && backup_size_in_gbs == other.backup_size_in_gbs && retention_in_days == other.retention_in_days && data_storage_size_in_gbs == other.data_storage_size_in_gbs && mysql_version == other.mysql_version && shape_name == other.shape_name && == other. && == other. && == other. && immediate_source_backup_id == other.immediate_source_backup_id && original_source_backup_id == other.original_source_backup_id && time_copy_created == other.time_copy_created end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/oci/mysql/models/backup.rb', line 472 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
452 453 454 |
# File 'lib/oci/mysql/models/backup.rb', line 452 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
461 462 463 |
# File 'lib/oci/mysql/models/backup.rb', line 461 def hash [id, display_name, description, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, backup_type, creation_type, db_system_id, db_system_snapshot, backup_size_in_gbs, retention_in_days, data_storage_size_in_gbs, mysql_version, shape_name, , , , immediate_source_backup_id, original_source_backup_id, time_copy_created].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
505 506 507 508 509 510 511 512 513 514 |
# File 'lib/oci/mysql/models/backup.rb', line 505 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
499 500 501 |
# File 'lib/oci/mysql/models/backup.rb', line 499 def to_s to_hash.to_s end |