Class: OCI::Mysql::Models::BackupSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/mysql/models/backup_summary.rb

Overview

Details of Backups such as OCID, description, backupType, and so on.

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

SOFT_DELETE_ENUM =
[
  SOFT_DELETE_ENABLED = 'ENABLED'.freeze,
  SOFT_DELETE_DISABLED = 'DISABLED'.freeze,
  SOFT_DELETE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackupSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/oci/mysql/models/backup_summary.rb', line 238

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

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

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

  self.backup_preparation_status = attributes[:'backupPreparationStatus'] if attributes[:'backupPreparationStatus']

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

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

  self.validation_status = attributes[:'validationStatus'] if attributes[:'validationStatus']

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

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

  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.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.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.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.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.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.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.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.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']

  self.db_system_snapshot_summary = attributes[:'dbSystemSnapshotSummary'] if attributes[:'dbSystemSnapshotSummary']

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

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

  self.encrypt_data = attributes[:'encryptData'] if attributes[:'encryptData']

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

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

Instance Attribute Details

#backup_preparation_statusString

Indicates whether the backup has been prepared successfully.

Returns:

  • (String)


45
46
47
# File 'lib/oci/mysql/models/backup_summary.rb', line 45

def backup_preparation_status
  @backup_preparation_status
end

#backup_size_in_gbsInteger

The size of the backup in GiBs.

Returns:

  • (Integer)


85
86
87
# File 'lib/oci/mysql/models/backup_summary.rb', line 85

def backup_size_in_gbs
  @backup_size_in_gbs
end

#backup_typeString

[Required] The type of backup.

Returns:

  • (String)


65
66
67
# File 'lib/oci/mysql/models/backup_summary.rb', line 65

def backup_type
  @backup_type
end

#compartment_idString

[Required] The OCID of the compartment the backup exists in.

Returns:

  • (String)


77
78
79
# File 'lib/oci/mysql/models/backup_summary.rb', line 77

def compartment_id
  @compartment_id
end

#creation_typeString

[Required] If the backup was created automatically, or by a manual request.

Returns:

  • (String)


69
70
71
# File 'lib/oci/mysql/models/backup_summary.rb', line 69

def creation_type
  @creation_type
end

#data_storage_size_in_gbsInteger

Size of the data volume in GiBs.

Returns:

  • (Integer)


81
82
83
# File 'lib/oci/mysql/models/backup_summary.rb', line 81

def data_storage_size_in_gbs
  @data_storage_size_in_gbs
end

#db_system_idString

[Required] The OCID of the DB System the Backup is associated with.

Returns:

  • (String)


73
74
75
# File 'lib/oci/mysql/models/backup_summary.rb', line 73

def db_system_id
  @db_system_id
end

#db_system_snapshot_summaryOCI::Mysql::Models::DbSystemSnapshotSummary



133
134
135
# File 'lib/oci/mysql/models/backup_summary.rb', line 133

def db_system_snapshot_summary
  @db_system_snapshot_summary
end

#defined_tagsHash<String, Hash<String, Object>>

Defined 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>>)


109
110
111
# File 'lib/oci/mysql/models/backup_summary.rb', line 109

def defined_tags
  @defined_tags
end

#descriptionString

A user-supplied description of the backup.

Returns:

  • (String)


34
35
36
# File 'lib/oci/mysql/models/backup_summary.rb', line 34

def description
  @description
end

#display_nameString

A user-supplied display name for the backup.

Returns:

  • (String)


30
31
32
# File 'lib/oci/mysql/models/backup_summary.rb', line 30

def display_name
  @display_name
end

#encrypt_dataOCI::Mysql::Models::EncryptDataDetails



136
137
138
# File 'lib/oci/mysql/models/backup_summary.rb', line 136

def encrypt_data
  @encrypt_data
end

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

Returns:

  • (Hash<String, String>)


103
104
105
# File 'lib/oci/mysql/models/backup_summary.rb', line 103

def freeform_tags
  @freeform_tags
end

#idString

[Required] OCID of the backup.

Returns:

  • (String)


26
27
28
# File 'lib/oci/mysql/models/backup_summary.rb', line 26

def id
  @id
end

#immediate_source_backup_idString

The OCID of the immediate source DB system backup from which this DB system backup was copied.

Returns:

  • (String)


120
121
122
# File 'lib/oci/mysql/models/backup_summary.rb', line 120

def immediate_source_backup_id
  @immediate_source_backup_id
end

#lifecycle_detailsString

Additional information about the current lifecycleState.

Returns:

  • (String)


61
62
63
# File 'lib/oci/mysql/models/backup_summary.rb', line 61

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The state of the backup.

Returns:

  • (String)


57
58
59
# File 'lib/oci/mysql/models/backup_summary.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#mysql_versionString

The version of the DB System used for backup.

Returns:

  • (String)


93
94
95
# File 'lib/oci/mysql/models/backup_summary.rb', line 93

def mysql_version
  @mysql_version
end

#original_source_backup_idString

The OCID of the original source DB system backup from which this DB system backup was copied.

Returns:

  • (String)


125
126
127
# File 'lib/oci/mysql/models/backup_summary.rb', line 125

def original_source_backup_id
  @original_source_backup_id
end

#retention_in_daysInteger

Number of days to retain this backup.

Returns:

  • (Integer)


89
90
91
# File 'lib/oci/mysql/models/backup_summary.rb', line 89

def retention_in_days
  @retention_in_days
end

#shape_nameString

The shape of the DB System instance used for backup.

Returns:

  • (String)


97
98
99
# File 'lib/oci/mysql/models/backup_summary.rb', line 97

def shape_name
  @shape_name
end

#soft_deleteString

Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.

Returns:

  • (String)


40
41
42
# File 'lib/oci/mysql/models/backup_summary.rb', line 40

def soft_delete
  @soft_delete
end

#system_tagsHash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


115
116
117
# File 'lib/oci/mysql/models/backup_summary.rb', line 115

def system_tags
  @system_tags
end

#time_copy_createdDateTime

The date and time the DB system backup copy was created, as described by RFC 3339.

Returns:

  • (DateTime)


130
131
132
# File 'lib/oci/mysql/models/backup_summary.rb', line 130

def time_copy_created
  @time_copy_created
end

#time_createdDateTime

[Required] The time the backup was created.

Returns:

  • (DateTime)


53
54
55
# File 'lib/oci/mysql/models/backup_summary.rb', line 53

def time_created
  @time_created
end

#validation_statusString

Status of the backup validation.

Returns:

  • (String)


49
50
51
# File 'lib/oci/mysql/models/backup_summary.rb', line 49

def validation_status
  @validation_status
end

Class Method Details

.attribute_mapObject

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



139
140
141
142
143
144
145
146
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/mysql/models/backup_summary.rb', line 139

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'soft_delete': :'softDelete',
    'backup_preparation_status': :'backupPreparationStatus',
    'validation_status': :'validationStatus',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'backup_type': :'backupType',
    'creation_type': :'creationType',
    'db_system_id': :'dbSystemId',
    'compartment_id': :'compartmentId',
    'data_storage_size_in_gbs': :'dataStorageSizeInGBs',
    'backup_size_in_gbs': :'backupSizeInGBs',
    'retention_in_days': :'retentionInDays',
    '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',
    'db_system_snapshot_summary': :'dbSystemSnapshotSummary',
    'encrypt_data': :'encryptData'
    # 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
197
198
199
200
201
202
203
204
# File 'lib/oci/mysql/models/backup_summary.rb', line 173

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'soft_delete': :'String',
    'backup_preparation_status': :'String',
    'validation_status': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'backup_type': :'String',
    'creation_type': :'String',
    'db_system_id': :'String',
    'compartment_id': :'String',
    'data_storage_size_in_gbs': :'Integer',
    'backup_size_in_gbs': :'Integer',
    'retention_in_days': :'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',
    'db_system_snapshot_summary': :'OCI::Mysql::Models::DbSystemSnapshotSummary',
    'encrypt_data': :'OCI::Mysql::Models::EncryptDataDetails'
    # 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



413
414
415
416
417
418
419
420
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/mysql/models/backup_summary.rb', line 413

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    soft_delete == other.soft_delete &&
    backup_preparation_status == other.backup_preparation_status &&
    validation_status == other.validation_status &&
    time_created == other.time_created &&
    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 &&
    compartment_id == other.compartment_id &&
    data_storage_size_in_gbs == other.data_storage_size_in_gbs &&
    backup_size_in_gbs == other.backup_size_in_gbs &&
    retention_in_days == other.retention_in_days &&
    mysql_version == other.mysql_version &&
    shape_name == other.shape_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    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 &&
    db_system_snapshot_summary == other.db_system_snapshot_summary &&
    encrypt_data == other.encrypt_data
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



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
# File 'lib/oci/mysql/models/backup_summary.rb', line 468

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


448
449
450
# File 'lib/oci/mysql/models/backup_summary.rb', line 448

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



457
458
459
# File 'lib/oci/mysql/models/backup_summary.rb', line 457

def hash
  [id, display_name, description, soft_delete, backup_preparation_status, validation_status, time_created, lifecycle_state, lifecycle_details, backup_type, creation_type, db_system_id, compartment_id, data_storage_size_in_gbs, backup_size_in_gbs, retention_in_days, mysql_version, shape_name, freeform_tags, defined_tags, system_tags, immediate_source_backup_id, original_source_backup_id, time_copy_created, db_system_snapshot_summary, encrypt_data].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



501
502
503
504
505
506
507
508
509
510
# File 'lib/oci/mysql/models/backup_summary.rb', line 501

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



495
496
497
# File 'lib/oci/mysql/models/backup_summary.rb', line 495

def to_s
  to_hash.to_s
end