Class: OCI::Core::Models::VolumeBackup
- Inherits:
-
Object
- Object
- OCI::Core::Models::VolumeBackup
- Defined in:
- lib/oci/core/models/volume_backup.rb
Overview
A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see Overview of Cloud Volume Storage.
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.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_FAULTY = 'FAULTY'.freeze, LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- SOURCE_TYPE_ENUM =
[ SOURCE_TYPE_MANUAL = 'MANUAL'.freeze, SOURCE_TYPE_SCHEDULED = 'SCHEDULED'.freeze, SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- TYPE_ENUM =
[ TYPE_FULL = 'FULL'.freeze, TYPE_INCREMENTAL = 'INCREMENTAL'.freeze, TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the volume backup.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name for the volume backup.
-
#expiration_time ⇒ DateTime
The date and time the volume backup will expire and be automatically deleted.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the volume backup.
-
#kms_key_id ⇒ String
The OCID of the Key Management key which is the master encryption key for the volume backup.
-
#lifecycle_state ⇒ String
[Required] The current state of a volume backup.
-
#size_in_gbs ⇒ Integer
The size of the volume, in GBs.
-
#size_in_mbs ⇒ Integer
The size of the volume in MBs.
-
#source_type ⇒ String
Specifies whether the backup was created manually, or via scheduled backup policy.
-
#source_volume_backup_id ⇒ String
The OCID of the source volume backup.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The date and time the volume backup was created.
-
#time_request_received ⇒ DateTime
The date and time the request to create the volume backup was received.
-
#type ⇒ String
[Required] The type of a volume backup.
-
#unique_size_in_gbs ⇒ Integer
The size used by the backup, in GBs.
-
#unique_size_in_mbs ⇒ Integer
The size used by the backup, in MBs.
-
#volume_id ⇒ String
The OCID of the volume.
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 = {}) ⇒ VolumeBackup
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 = {}) ⇒ VolumeBackup
Initializes the object
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 336 337 338 339 340 341 |
# File 'lib/oci/core/models/volume_backup.rb', line 230 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.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. = 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.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.expiration_time = attributes[:'expirationTime'] if attributes[:'expirationTime'] raise 'You cannot provide both :expirationTime and :expiration_time' if attributes.key?(:'expirationTime') && attributes.key?(:'expiration_time') self.expiration_time = attributes[:'expiration_time'] if attributes[:'expiration_time'] 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.id = attributes[:'id'] if attributes[:'id'] 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.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.size_in_gbs = attributes[:'sizeInGBs'] if attributes[:'sizeInGBs'] raise 'You cannot provide both :sizeInGBs and :size_in_gbs' if attributes.key?(:'sizeInGBs') && attributes.key?(:'size_in_gbs') self.size_in_gbs = attributes[:'size_in_gbs'] if attributes[:'size_in_gbs'] self.size_in_mbs = attributes[:'sizeInMBs'] if attributes[:'sizeInMBs'] raise 'You cannot provide both :sizeInMBs and :size_in_mbs' if attributes.key?(:'sizeInMBs') && attributes.key?(:'size_in_mbs') self.size_in_mbs = attributes[:'size_in_mbs'] if attributes[:'size_in_mbs'] self.source_type = attributes[:'sourceType'] if attributes[:'sourceType'] raise 'You cannot provide both :sourceType and :source_type' if attributes.key?(:'sourceType') && attributes.key?(:'source_type') self.source_type = attributes[:'source_type'] if attributes[:'source_type'] self.source_volume_backup_id = attributes[:'sourceVolumeBackupId'] if attributes[:'sourceVolumeBackupId'] raise 'You cannot provide both :sourceVolumeBackupId and :source_volume_backup_id' if attributes.key?(:'sourceVolumeBackupId') && attributes.key?(:'source_volume_backup_id') self.source_volume_backup_id = attributes[:'source_volume_backup_id'] if attributes[:'source_volume_backup_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_request_received = attributes[:'timeRequestReceived'] if attributes[:'timeRequestReceived'] raise 'You cannot provide both :timeRequestReceived and :time_request_received' if attributes.key?(:'timeRequestReceived') && attributes.key?(:'time_request_received') self.time_request_received = attributes[:'time_request_received'] if attributes[:'time_request_received'] self.type = attributes[:'type'] if attributes[:'type'] self.unique_size_in_gbs = attributes[:'uniqueSizeInGBs'] if attributes[:'uniqueSizeInGBs'] raise 'You cannot provide both :uniqueSizeInGBs and :unique_size_in_gbs' if attributes.key?(:'uniqueSizeInGBs') && attributes.key?(:'unique_size_in_gbs') self.unique_size_in_gbs = attributes[:'unique_size_in_gbs'] if attributes[:'unique_size_in_gbs'] self.unique_size_in_mbs = attributes[:'uniqueSizeInMbs'] if attributes[:'uniqueSizeInMbs'] raise 'You cannot provide both :uniqueSizeInMbs and :unique_size_in_mbs' if attributes.key?(:'uniqueSizeInMbs') && attributes.key?(:'unique_size_in_mbs') self.unique_size_in_mbs = attributes[:'unique_size_in_mbs'] if attributes[:'unique_size_in_mbs'] self.volume_id = attributes[:'volumeId'] if attributes[:'volumeId'] raise 'You cannot provide both :volumeId and :volume_id' if attributes.key?(:'volumeId') && attributes.key?(:'volume_id') self.volume_id = attributes[:'volume_id'] if attributes[:'volume_id'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the volume backup.
45 46 47 |
# File 'lib/oci/core/models/volume_backup.rb', line 45 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
53 54 55 |
# File 'lib/oci/core/models/volume_backup.rb', line 53 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name for the volume backup. Does not have to be unique and it's changeable. Avoid entering confidential information.
65 66 67 |
# File 'lib/oci/core/models/volume_backup.rb', line 65 def display_name @display_name end |
#expiration_time ⇒ DateTime
The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
74 75 76 |
# File 'lib/oci/core/models/volume_backup.rb', line 74 def expiration_time @expiration_time end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {\"Department\": \"Finance\"}
82 83 84 |
# File 'lib/oci/core/models/volume_backup.rb', line 82 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the volume backup.
86 87 88 |
# File 'lib/oci/core/models/volume_backup.rb', line 86 def id @id end |
#kms_key_id ⇒ String
The OCID of the Key Management key which is the master encryption key for the volume backup. For more information about the Key Management service and encryption keys, see Overview of Key Management and Using Keys.
94 95 96 |
# File 'lib/oci/core/models/volume_backup.rb', line 94 def kms_key_id @kms_key_id end |
#lifecycle_state ⇒ String
[Required] The current state of a volume backup.
98 99 100 |
# File 'lib/oci/core/models/volume_backup.rb', line 98 def lifecycle_state @lifecycle_state end |
#size_in_gbs ⇒ Integer
The size of the volume, in GBs.
103 104 105 |
# File 'lib/oci/core/models/volume_backup.rb', line 103 def size_in_gbs @size_in_gbs end |
#size_in_mbs ⇒ Integer
The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
109 110 111 |
# File 'lib/oci/core/models/volume_backup.rb', line 109 def size_in_mbs @size_in_mbs end |
#source_type ⇒ String
Specifies whether the backup was created manually, or via scheduled backup policy.
113 114 115 |
# File 'lib/oci/core/models/volume_backup.rb', line 113 def source_type @source_type end |
#source_volume_backup_id ⇒ String
The OCID of the source volume backup.
117 118 119 |
# File 'lib/oci/core/models/volume_backup.rb', line 117 def source_volume_backup_id @source_volume_backup_id end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
59 60 61 |
# File 'lib/oci/core/models/volume_backup.rb', line 59 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
123 124 125 |
# File 'lib/oci/core/models/volume_backup.rb', line 123 def time_created @time_created end |
#time_request_received ⇒ DateTime
The date and time the request to create the volume backup was received. Format defined by RFC3339.
128 129 130 |
# File 'lib/oci/core/models/volume_backup.rb', line 128 def time_request_received @time_request_received end |
#type ⇒ String
[Required] The type of a volume backup.
132 133 134 |
# File 'lib/oci/core/models/volume_backup.rb', line 132 def type @type end |
#unique_size_in_gbs ⇒ Integer
The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
138 139 140 |
# File 'lib/oci/core/models/volume_backup.rb', line 138 def unique_size_in_gbs @unique_size_in_gbs end |
#unique_size_in_mbs ⇒ Integer
The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
145 146 147 |
# File 'lib/oci/core/models/volume_backup.rb', line 145 def unique_size_in_mbs @unique_size_in_mbs end |
#volume_id ⇒ String
The OCID of the volume.
149 150 151 |
# File 'lib/oci/core/models/volume_backup.rb', line 149 def volume_id @volume_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/oci/core/models/volume_backup.rb', line 152 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'system_tags': :'systemTags', 'display_name': :'displayName', 'expiration_time': :'expirationTime', 'freeform_tags': :'freeformTags', 'id': :'id', 'kms_key_id': :'kmsKeyId', 'lifecycle_state': :'lifecycleState', 'size_in_gbs': :'sizeInGBs', 'size_in_mbs': :'sizeInMBs', 'source_type': :'sourceType', 'source_volume_backup_id': :'sourceVolumeBackupId', 'time_created': :'timeCreated', 'time_request_received': :'timeRequestReceived', 'type': :'type', 'unique_size_in_gbs': :'uniqueSizeInGBs', 'unique_size_in_mbs': :'uniqueSizeInMbs', 'volume_id': :'volumeId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/core/models/volume_backup.rb', line 179 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'expiration_time': :'DateTime', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'kms_key_id': :'String', 'lifecycle_state': :'String', 'size_in_gbs': :'Integer', 'size_in_mbs': :'Integer', 'source_type': :'String', 'source_volume_backup_id': :'String', 'time_created': :'DateTime', 'time_request_received': :'DateTime', 'type': :'String', 'unique_size_in_gbs': :'Integer', 'unique_size_in_mbs': :'Integer', 'volume_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 |
# File 'lib/oci/core/models/volume_backup.rb', line 389 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && == other. && display_name == other.display_name && expiration_time == other.expiration_time && == other. && id == other.id && kms_key_id == other.kms_key_id && lifecycle_state == other.lifecycle_state && size_in_gbs == other.size_in_gbs && size_in_mbs == other.size_in_mbs && source_type == other.source_type && source_volume_backup_id == other.source_volume_backup_id && time_created == other.time_created && time_request_received == other.time_request_received && type == other.type && unique_size_in_gbs == other.unique_size_in_gbs && unique_size_in_mbs == other.unique_size_in_mbs && volume_id == other.volume_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/oci/core/models/volume_backup.rb', line 437 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
417 418 419 |
# File 'lib/oci/core/models/volume_backup.rb', line 417 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
426 427 428 |
# File 'lib/oci/core/models/volume_backup.rb', line 426 def hash [compartment_id, , , display_name, expiration_time, , id, kms_key_id, lifecycle_state, size_in_gbs, size_in_mbs, source_type, source_volume_backup_id, time_created, time_request_received, type, unique_size_in_gbs, unique_size_in_mbs, volume_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
470 471 472 473 474 475 476 477 478 479 |
# File 'lib/oci/core/models/volume_backup.rb', line 470 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
464 465 466 |
# File 'lib/oci/core/models/volume_backup.rb', line 464 def to_s to_hash.to_s end |