Class: OCI::Core::Models::VolumeBackup

Inherits:
Object
  • Object
show all
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeBackup

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/oci/core/models/volume_backup.rb', line 273

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.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = 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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = 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']

  self.time_retention_expires_at = attributes[:'timeRetentionExpiresAt'] if attributes[:'timeRetentionExpiresAt']

  raise 'You cannot provide both :timeRetentionExpiresAt and :time_retention_expires_at' if attributes.key?(:'timeRetentionExpiresAt') && attributes.key?(:'time_retention_expires_at')

  self.time_retention_expires_at = attributes[:'time_retention_expires_at'] if attributes[:'time_retention_expires_at']

  self.retention_period = attributes[:'retentionPeriod'] if attributes[:'retentionPeriod']

  raise 'You cannot provide both :retentionPeriod and :retention_period' if attributes.key?(:'retentionPeriod') && attributes.key?(:'retention_period')

  self.retention_period = attributes[:'retention_period'] if attributes[:'retention_period']

  self.is_prevent_deletion_enabled = attributes[:'isPreventDeletionEnabled'] unless attributes[:'isPreventDeletionEnabled'].nil?

  raise 'You cannot provide both :isPreventDeletionEnabled and :is_prevent_deletion_enabled' if attributes.key?(:'isPreventDeletionEnabled') && attributes.key?(:'is_prevent_deletion_enabled')

  self.is_prevent_deletion_enabled = attributes[:'is_prevent_deletion_enabled'] unless attributes[:'is_prevent_deletion_enabled'].nil?

  self.is_retention_lock_enabled = attributes[:'isRetentionLockEnabled'] unless attributes[:'isRetentionLockEnabled'].nil?

  raise 'You cannot provide both :isRetentionLockEnabled and :is_retention_lock_enabled' if attributes.key?(:'isRetentionLockEnabled') && attributes.key?(:'is_retention_lock_enabled')

  self.is_retention_lock_enabled = attributes[:'is_retention_lock_enabled'] unless attributes[:'is_retention_lock_enabled'].nil?

  self.is_indefinite_retention_enabled = attributes[:'isIndefiniteRetentionEnabled'] unless attributes[:'isIndefiniteRetentionEnabled'].nil?

  raise 'You cannot provide both :isIndefiniteRetentionEnabled and :is_indefinite_retention_enabled' if attributes.key?(:'isIndefiniteRetentionEnabled') && attributes.key?(:'is_indefinite_retention_enabled')

  self.is_indefinite_retention_enabled = attributes[:'is_indefinite_retention_enabled'] unless attributes[:'is_indefinite_retention_enabled'].nil?

  self.volume_group_backup_id = attributes[:'volumeGroupBackupId'] if attributes[:'volumeGroupBackupId']

  raise 'You cannot provide both :volumeGroupBackupId and :volume_group_backup_id' if attributes.key?(:'volumeGroupBackupId') && attributes.key?(:'volume_group_backup_id')

  self.volume_group_backup_id = attributes[:'volume_group_backup_id'] if attributes[:'volume_group_backup_id']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the volume backup.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/core/models/volume_backup.rb', line 46

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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


54
55
56
 
# File 'lib/oci/core/models/volume_backup.rb', line 54

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/core/models/volume_backup.rb', line 66

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.

Returns:

  • (DateTime) 


75
76
77
 
# File 'lib/oci/core/models/volume_backup.rb', line 75

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\"}

Returns:

  • (Hash<String, String>) 


83
84
85
 
# File 'lib/oci/core/models/volume_backup.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the volume backup.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/core/models/volume_backup.rb', line 87

def id
  @id
end

#is_indefinite_retention_enabled ⇒ BOOLEAN

feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.

Returns:

  • (BOOLEAN) 


170
171
172
 
# File 'lib/oci/core/models/volume_backup.rb', line 170

def is_indefinite_retention_enabled
  @is_indefinite_retention_enabled
end

#is_prevent_deletion_enabled ⇒ BOOLEAN

Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.

Returns:

  • (BOOLEAN) 


162
163
164
 
# File 'lib/oci/core/models/volume_backup.rb', line 162

def is_prevent_deletion_enabled
  @is_prevent_deletion_enabled
end

#is_retention_lock_enabled ⇒ BOOLEAN

feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.

Returns:

  • (BOOLEAN) 


166
167
168
 
# File 'lib/oci/core/models/volume_backup.rb', line 166

def is_retention_lock_enabled
  @is_retention_lock_enabled
end

#kms_key_id ⇒ String

The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/core/models/volume_backup.rb', line 95

def kms_key_id
  @kms_key_id
end

#lifecycle_state ⇒ String

[Required] The current state of a volume backup.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/core/models/volume_backup.rb', line 99

def lifecycle_state
  @lifecycle_state
end

#retention_period ⇒ OCI::Core::Models::RetentionDuration

Returns:



158
159
160
 
# File 'lib/oci/core/models/volume_backup.rb', line 158

def retention_period
  @retention_period
end

#size_in_gbs ⇒ Integer

The size of the volume, in GBs.

Returns:

  • (Integer) 


104
105
106
 
# File 'lib/oci/core/models/volume_backup.rb', line 104

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.

Returns:

  • (Integer) 


110
111
112
 
# File 'lib/oci/core/models/volume_backup.rb', line 110

def size_in_mbs
  @size_in_mbs
end

#source_type ⇒ String

Specifies whether the backup was created manually, or via scheduled backup policy.

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/core/models/volume_backup.rb', line 115

def source_type
  @source_type
end

#source_volume_backup_id ⇒ String

The OCID of the source volume backup.

Returns:

  • (String) 


119
120
121
 
# File 'lib/oci/core/models/volume_backup.rb', line 119

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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


60
61
62
 
# File 'lib/oci/core/models/volume_backup.rb', line 60

def system_tags
  @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.

Returns:

  • (DateTime) 


125
126
127
 
# File 'lib/oci/core/models/volume_backup.rb', line 125

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]tools.ietf.org/html/rfc3339.

Returns:

  • (DateTime) 


130
131
132
 
# File 'lib/oci/core/models/volume_backup.rb', line 130

def time_request_received
  @time_request_received
end

#time_retention_expires_at ⇒ DateTime

The date and time when a backupu2019s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.

Returns:

  • (DateTime) 


155
156
157
 
# File 'lib/oci/core/models/volume_backup.rb', line 155

def time_retention_expires_at
  @time_retention_expires_at
end

#type ⇒ String

[Required] The type of a volume backup.

Returns:

  • (String) 


134
135
136
 
# File 'lib/oci/core/models/volume_backup.rb', line 134

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.

Returns:

  • (Integer) 


140
141
142
 
# File 'lib/oci/core/models/volume_backup.rb', line 140

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.

Returns:

  • (Integer) 


147
148
149
 
# File 'lib/oci/core/models/volume_backup.rb', line 147

def unique_size_in_mbs
  @unique_size_in_mbs
end

#volume_group_backup_id ⇒ String

The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group.

Returns:

  • (String) 


174
175
176
 
# File 'lib/oci/core/models/volume_backup.rb', line 174

def volume_group_backup_id
  @volume_group_backup_id
end

#volume_id ⇒ String

The OCID of the volume.

Returns:

  • (String) 


151
152
153
 
# File 'lib/oci/core/models/volume_backup.rb', line 151

def volume_id
  @volume_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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
203
204
205
206
207
 
# File 'lib/oci/core/models/volume_backup.rb', line 177

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',
    'time_retention_expires_at': :'timeRetentionExpiresAt',
    'retention_period': :'retentionPeriod',
    'is_prevent_deletion_enabled': :'isPreventDeletionEnabled',
    'is_retention_lock_enabled': :'isRetentionLockEnabled',
    'is_indefinite_retention_enabled': :'isIndefiniteRetentionEnabled',
    'volume_group_backup_id': :'volumeGroupBackupId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/core/models/volume_backup.rb', line 210

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',
    'time_retention_expires_at': :'DateTime',
    'retention_period': :'OCI::Core::Models::RetentionDuration',
    'is_prevent_deletion_enabled': :'BOOLEAN',
    'is_retention_lock_enabled': :'BOOLEAN',
    'is_indefinite_retention_enabled': :'BOOLEAN',
    'volume_group_backup_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/oci/core/models/volume_backup.rb', line 468

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    display_name == other.display_name &&
    expiration_time == other.expiration_time &&
    freeform_tags == other.freeform_tags &&
    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 &&
    time_retention_expires_at == other.time_retention_expires_at &&
    retention_period == other.retention_period &&
    is_prevent_deletion_enabled == other.is_prevent_deletion_enabled &&
    is_retention_lock_enabled == other.is_retention_lock_enabled &&
    is_indefinite_retention_enabled == other.is_indefinite_retention_enabled &&
    volume_group_backup_id == other.volume_group_backup_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/oci/core/models/volume_backup.rb', line 522

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


502
503
504
 
# File 'lib/oci/core/models/volume_backup.rb', line 502

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



511
512
513
 
# File 'lib/oci/core/models/volume_backup.rb', line 511

def hash
  [compartment_id, defined_tags, system_tags, display_name, expiration_time, freeform_tags, 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, time_retention_expires_at, retention_period, is_prevent_deletion_enabled, is_retention_lock_enabled, is_indefinite_retention_enabled, volume_group_backup_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



555
556
557
558
559
560
561
562
563
564
 
# File 'lib/oci/core/models/volume_backup.rb', line 555

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

Returns:

  • (String) —

    String presentation of the object



549
550
551
 
# File 'lib/oci/core/models/volume_backup.rb', line 549

def to_s
  to_hash.to_s
end