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.

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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
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
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 195

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

Instance Attribute Details

#backup_size_in_gbs ⇒ Integer

The size of the backup in GiBs.

Returns:

  • (Integer) 


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

def backup_size_in_gbs
  @backup_size_in_gbs
end

#backup_type ⇒ String

[Required] The type of backup.

Returns:

  • (String) 


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

def backup_type
  @backup_type
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#creation_type ⇒ String

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

Returns:

  • (String) 


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

def creation_type
  @creation_type
end

#data_storage_size_in_gbs ⇒ Integer

Size of the data volume in GiBs.

Returns:

  • (Integer) 


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

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.

Returns:

  • (String) 


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

def db_system_id
  @db_system_id
end

#db_system_snapshot_summary ⇒ OCI::Mysql::Models::DbSystemSnapshotSummary

Returns:



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

def db_system_snapshot_summary
  @db_system_snapshot_summary
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\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-supplied description of the backup.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 28

def description
  @description
end

#display_name ⇒ String

A user-supplied display name for the backup.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 24

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

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID of the backup.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 20

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.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 95

def immediate_source_backup_id
  @immediate_source_backup_id
end

#lifecycle_state ⇒ String

[Required] The state of the backup.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 36

def lifecycle_state
  @lifecycle_state
end

#mysql_version ⇒ String

The version of the DB System used for backup.

Returns:

  • (String) 


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

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.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 100

def original_source_backup_id
  @original_source_backup_id
end

#retention_in_days ⇒ Integer

Number of days to retain this backup.

Returns:

  • (Integer) 


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

def retention_in_days
  @retention_in_days
end

#shape_name ⇒ String

The shape of the DB System instance used for backup.

Returns:

  • (String) 


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

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

Returns:

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


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

def system_tags
  @system_tags
end

#time_copy_created ⇒ DateTime

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

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 105

def time_copy_created
  @time_copy_created
end

#time_created ⇒ DateTime

[Required] The time the backup was created.

Returns:

  • (DateTime) 


32
33
34
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 32

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 111

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    '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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 140

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'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'
    # 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



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
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 327

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    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
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



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

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


357
358
359
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 357

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



366
367
368
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 366

def hash
  [id, display_name, description, time_created, lifecycle_state, 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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 410

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



404
405
406
 
# File 'lib/oci/mysql/models/backup_summary.rb', line 404

def to_s
  to_hash.to_s
end