Class: OCI::Psql::Models::BackupSummary

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

Overview

Summary information for a backup.

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

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :source_type (String) —

    The value to assign to the #source_type property

  • :time_created_precise (DateTime) —

    The value to assign to the #time_created_precise property

  • :backup_size (Integer) —

    The value to assign to the #backup_size property

  • :db_system_id (String) —

    The value to assign to the #db_system_id property

  • :retention_period (Integer) —

    The value to assign to the #retention_period property

  • :copy_status (Array<OCI::Psql::Models::BackupCopyStatusDetails>) —

    The value to assign to the #copy_status property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



165
166
167
168
169
170
171
172
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
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
 
# File 'lib/oci/psql/models/backup_summary.rb', line 165

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

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

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

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

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

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

  self.backup_size = attributes[:'backupSize'] if attributes[:'backupSize']

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

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

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

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

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

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

Instance Attribute Details

#backup_size ⇒ Integer

The size of the backup, in gigabytes.

Returns:

  • (Integer) 


63
64
65
 
# File 'lib/oci/psql/models/backup_summary.rb', line 63

def backup_size
  @backup_size
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/psql/models/backup_summary.rb', line 22

def compartment_id
  @compartment_id
end

#copy_status ⇒ Array<OCI::Psql::Models::BackupCopyStatusDetails>

List of status for Backup Copy

Returns:



75
76
77
 
# File 'lib/oci/psql/models/backup_summary.rb', line 75

def copy_status
  @copy_status
end

#db_system_id ⇒ String

The backup's source database system's OCID.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/psql/models/backup_summary.rb', line 67

def db_system_id
  @db_system_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] 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>>) 


87
88
89
 
# File 'lib/oci/psql/models/backup_summary.rb', line 87

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly display name for the backup. Avoid entering confidential information.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/psql/models/backup_summary.rb', line 18

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] A unique identifier for the backup. Immutable on creation.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/psql/models/backup_summary.rb', line 14

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/psql/models/backup_summary.rb', line 46

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the backup.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/psql/models/backup_summary.rb', line 42

def lifecycle_state
  @lifecycle_state
end

#retention_period ⇒ Integer

Backup retention period in days.

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/oci/psql/models/backup_summary.rb', line 71

def retention_period
  @retention_period
end

#source_type ⇒ String

Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/psql/models/backup_summary.rb', line 50

def source_type
  @source_type
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the backup was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_created_precise ⇒ DateTime

The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/psql/models/backup_summary.rb', line 59

def time_created_precise
  @time_created_precise
end

#time_updated ⇒ DateTime

The date and time the backup was updated, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/psql/models/backup_summary.rb', line 38

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/psql/models/backup_summary.rb', line 96

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'source_type': :'sourceType',
    'time_created_precise': :'timeCreatedPrecise',
    'backup_size': :'backupSize',
    'db_system_id': :'dbSystemId',
    'retention_period': :'retentionPeriod',
    'copy_status': :'copyStatus',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/psql/models/backup_summary.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'source_type': :'String',
    'time_created_precise': :'DateTime',
    'backup_size': :'Integer',
    'db_system_id': :'String',
    'retention_period': :'Integer',
    'copy_status': :'Array<OCI::Psql::Models::BackupCopyStatusDetails>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/psql/models/backup_summary.rb', line 271

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    source_type == other.source_type &&
    time_created_precise == other.time_created_precise &&
    backup_size == other.backup_size &&
    db_system_id == other.db_system_id &&
    retention_period == other.retention_period &&
    copy_status == other.copy_status &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/psql/models/backup_summary.rb', line 316

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


296
297
298
 
# File 'lib/oci/psql/models/backup_summary.rb', line 296

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



305
306
307
 
# File 'lib/oci/psql/models/backup_summary.rb', line 305

def hash
  [id, display_name, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, source_type, time_created_precise, backup_size, db_system_id, retention_period, copy_status, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/psql/models/backup_summary.rb', line 349

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



343
344
345
 
# File 'lib/oci/psql/models/backup_summary.rb', line 343

def to_s
  to_hash.to_s
end