Class: OCI::Core::Models::VolumeGroupBackup

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/volume_group_backup.rb

Overview

A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see Volume Groups.

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_COMMITTED = 'COMMITTED'.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 = {}) ⇒ VolumeGroupBackup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String)

    The value to assign to the #compartment_id property

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

    The value to assign to the #defined_tags property

  • :display_name (String)

    The value to assign to the #display_name property

  • :expiration_time (DateTime)

    The value to assign to the #expiration_time property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :id (String)

    The value to assign to the #id property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :size_in_mbs (Integer)

    The value to assign to the #size_in_mbs property

  • :size_in_gbs (Integer)

    The value to assign to the #size_in_gbs property

  • :source_type (String)

    The value to assign to the #source_type property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_request_received (DateTime)

    The value to assign to the #time_request_received property

  • :type (String)

    The value to assign to the #type property

  • :unique_size_in_mbs (Integer)

    The value to assign to the #unique_size_in_mbs property

  • :unique_size_in_gbs (Integer)

    The value to assign to the #unique_size_in_gbs property

  • :volume_backup_ids (Array<String>)

    The value to assign to the #volume_backup_ids property

  • :volume_group_id (String)

    The value to assign to the #volume_group_id property

  • :source_volume_group_backup_id (String)

    The value to assign to the #source_volume_group_backup_id property



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

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.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.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_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.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.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.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_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.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.volume_backup_ids = attributes[:'volumeBackupIds'] if attributes[:'volumeBackupIds']

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

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

  self.volume_group_id = attributes[:'volumeGroupId'] if attributes[:'volumeGroupId']

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

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

  self.source_volume_group_backup_id = attributes[:'sourceVolumeGroupBackupId'] if attributes[:'sourceVolumeGroupBackupId']

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

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

Instance Attribute Details

#compartment_idString

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

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#defined_tagsHash<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_group_backup.rb', line 54

def defined_tags
  @defined_tags
end

#display_nameString

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

Returns:

  • (String)


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

def display_name
  @display_name
end

#expiration_timeDateTime

The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.

Returns:

  • (DateTime)


69
70
71
# File 'lib/oci/core/models/volume_group_backup.rb', line 69

def expiration_time
  @expiration_time
end

#freeform_tagsHash<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>)


77
78
79
# File 'lib/oci/core/models/volume_group_backup.rb', line 77

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the volume group backup.

Returns:

  • (String)


81
82
83
# File 'lib/oci/core/models/volume_group_backup.rb', line 81

def id
  @id
end

#lifecycle_stateString

[Required] The current state of a volume group backup.

Returns:

  • (String)


85
86
87
# File 'lib/oci/core/models/volume_group_backup.rb', line 85

def lifecycle_state
  @lifecycle_state
end

#size_in_gbsInteger

The aggregate size of the volume group backup, in GBs.

Returns:

  • (Integer)


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

def size_in_gbs
  @size_in_gbs
end

#size_in_mbsInteger

The aggregate size of the volume group backup, in MBs.

Returns:

  • (Integer)


90
91
92
# File 'lib/oci/core/models/volume_group_backup.rb', line 90

def size_in_mbs
  @size_in_mbs
end

#source_typeString

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

Returns:

  • (String)


101
102
103
# File 'lib/oci/core/models/volume_group_backup.rb', line 101

def source_type
  @source_type
end

#source_volume_group_backup_idString

The OCID of the source volume group backup.

Returns:

  • (String)


144
145
146
# File 'lib/oci/core/models/volume_group_backup.rb', line 144

def source_volume_group_backup_id
  @source_volume_group_backup_id
end

#time_createdDateTime

[Required] The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.

Returns:

  • (DateTime)


107
108
109
# File 'lib/oci/core/models/volume_group_backup.rb', line 107

def time_created
  @time_created
end

#time_request_receivedDateTime

The date and time the request to create the volume group backup was received. Format defined by RFC3339.

Returns:

  • (DateTime)


112
113
114
# File 'lib/oci/core/models/volume_group_backup.rb', line 112

def time_request_received
  @time_request_received
end

#typeString

[Required] The type of backup.

Returns:

  • (String)


116
117
118
# File 'lib/oci/core/models/volume_group_backup.rb', line 116

def type
  @type
end

#unique_size_in_gbsInteger

The aggregate size used by the volume group backup, in GBs.

It is typically smaller than sizeInGBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.

Returns:

  • (Integer)


132
133
134
# File 'lib/oci/core/models/volume_group_backup.rb', line 132

def unique_size_in_gbs
  @unique_size_in_gbs
end

#unique_size_in_mbsInteger

The aggregate size used by the volume group backup, in MBs.

It is typically smaller than sizeInMBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.

Returns:

  • (Integer)


124
125
126
# File 'lib/oci/core/models/volume_group_backup.rb', line 124

def unique_size_in_mbs
  @unique_size_in_mbs
end

#volume_backup_idsArray<String>

[Required] OCIDs for the volume backups in this volume group backup.

Returns:

  • (Array<String>)


136
137
138
# File 'lib/oci/core/models/volume_group_backup.rb', line 136

def volume_backup_ids
  @volume_backup_ids
end

#volume_group_idString

The OCID of the source volume group.

Returns:

  • (String)


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

def volume_group_id
  @volume_group_id
end

Class Method Details

.attribute_mapObject

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'expiration_time': :'expirationTime',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'size_in_mbs': :'sizeInMBs',
    'size_in_gbs': :'sizeInGBs',
    'source_type': :'sourceType',
    'time_created': :'timeCreated',
    'time_request_received': :'timeRequestReceived',
    'type': :'type',
    'unique_size_in_mbs': :'uniqueSizeInMbs',
    'unique_size_in_gbs': :'uniqueSizeInGbs',
    'volume_backup_ids': :'volumeBackupIds',
    'volume_group_id': :'volumeGroupId',
    'source_volume_group_backup_id': :'sourceVolumeGroupBackupId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/oci/core/models/volume_group_backup.rb', line 173

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'expiration_time': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'lifecycle_state': :'String',
    'size_in_mbs': :'Integer',
    'size_in_gbs': :'Integer',
    'source_type': :'String',
    'time_created': :'DateTime',
    'time_request_received': :'DateTime',
    'type': :'String',
    'unique_size_in_mbs': :'Integer',
    'unique_size_in_gbs': :'Integer',
    'volume_backup_ids': :'Array<String>',
    'volume_group_id': :'String',
    'source_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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/oci/core/models/volume_group_backup.rb', line 375

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    expiration_time == other.expiration_time &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    size_in_mbs == other.size_in_mbs &&
    size_in_gbs == other.size_in_gbs &&
    source_type == other.source_type &&
    time_created == other.time_created &&
    time_request_received == other.time_request_received &&
    type == other.type &&
    unique_size_in_mbs == other.unique_size_in_mbs &&
    unique_size_in_gbs == other.unique_size_in_gbs &&
    volume_backup_ids == other.volume_backup_ids &&
    volume_group_id == other.volume_group_id &&
    source_volume_group_backup_id == other.source_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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
# File 'lib/oci/core/models/volume_group_backup.rb', line 422

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


402
403
404
# File 'lib/oci/core/models/volume_group_backup.rb', line 402

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



411
412
413
# File 'lib/oci/core/models/volume_group_backup.rb', line 411

def hash
  [compartment_id, defined_tags, display_name, expiration_time, freeform_tags, id, lifecycle_state, size_in_mbs, size_in_gbs, source_type, time_created, time_request_received, type, unique_size_in_mbs, unique_size_in_gbs, volume_backup_ids, volume_group_id, source_volume_group_backup_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



455
456
457
458
459
460
461
462
463
464
# File 'lib/oci/core/models/volume_group_backup.rb', line 455

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



449
450
451
# File 'lib/oci/core/models/volume_group_backup.rb', line 449

def to_s
  to_hash.to_s
end