Class: OCI::Psql::Models::Backup

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

Overview

Database system backup information.

Constant Summary collapse

SOURCE_TYPE_ENUM = 
[
  SOURCE_TYPE_SCHEDULED = 'SCHEDULED'.freeze,
  SOURCE_TYPE_MANUAL = 'MANUAL'.freeze,
  SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Backup

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

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id 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_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

  • :retention_period (Integer) —

    The value to assign to the #retention_period 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

  • :db_system_details (OCI::Psql::Models::DbSystemDetails) —

    The value to assign to the #db_system_details property

  • :last_accepted_request_token (String) —

    The value to assign to the #last_accepted_request_token property

  • :last_completed_request_token (String) —

    The value to assign to the #last_completed_request_token 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



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
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
 
# File 'lib/oci/psql/models/backup.rb', line 189

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

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

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

  self.last_accepted_request_token = attributes[:'lastAcceptedRequestToken'] if attributes[:'lastAcceptedRequestToken']

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

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

  self.last_completed_request_token = attributes[:'lastCompletedRequestToken'] if attributes[:'lastCompletedRequestToken']

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

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

  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

[Required] The size of the backup, in gigabytes.

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/psql/models/backup.rb', line 77

def backup_size
  @backup_size
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/psql/models/backup.rb', line 41

def compartment_id
  @compartment_id
end

#db_system_details ⇒ OCI::Psql::Models::DbSystemDetails

This attribute is required.

Returns:



85
86
87
 
# File 'lib/oci/psql/models/backup.rb', line 85

def db_system_details
  @db_system_details
end

#db_system_id ⇒ String

The OCID of the backup's source database system.

Returns:

  • (String) 


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

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


105
106
107
 
# File 'lib/oci/psql/models/backup.rb', line 105

def defined_tags
  @defined_tags
end

#description ⇒ String

A description for the backup.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/psql/models/backup.rb', line 37

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/psql/models/backup.rb', line 33

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


99
100
101
 
# File 'lib/oci/psql/models/backup.rb', line 99

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the backup.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/psql/models/backup.rb', line 29

def id
  @id
end

#last_accepted_request_token ⇒ String

lastAcceptedRequestToken from MP.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/psql/models/backup.rb', line 89

def last_accepted_request_token
  @last_accepted_request_token
end

#last_completed_request_token ⇒ String

lastCompletedRequestToken from MP.

Returns:

  • (String) 


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

def last_completed_request_token
  @last_completed_request_token
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) 


69
70
71
 
# File 'lib/oci/psql/models/backup.rb', line 69

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the backup.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/psql/models/backup.rb', line 65

def lifecycle_state
  @lifecycle_state
end

#retention_period ⇒ Integer

Backup retention period in days.

Returns:

  • (Integer) 


73
74
75
 
# File 'lib/oci/psql/models/backup.rb', line 73

def retention_period
  @retention_period
end

#source_type ⇒ String

Specifies whether the backup was created manually, or by a management policy.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/psql/models/backup.rb', line 45

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


111
112
113
 
# File 'lib/oci/psql/models/backup.rb', line 111

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) 


53
54
55
 
# File 'lib/oci/psql/models/backup.rb', line 53

def time_created
  @time_created
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) 


61
62
63
 
# File 'lib/oci/psql/models/backup.rb', line 61

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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/psql/models/backup.rb', line 114

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'source_type': :'sourceType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'retention_period': :'retentionPeriod',
    'backup_size': :'backupSize',
    'db_system_id': :'dbSystemId',
    'db_system_details': :'dbSystemDetails',
    'last_accepted_request_token': :'lastAcceptedRequestToken',
    'last_completed_request_token': :'lastCompletedRequestToken',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # 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
 
# File 'lib/oci/psql/models/backup.rb', line 140

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'source_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'retention_period': :'Integer',
    'backup_size': :'Integer',
    'db_system_id': :'String',
    'db_system_details': :'OCI::Psql::Models::DbSystemDetails',
    'last_accepted_request_token': :'String',
    'last_completed_request_token': :'String',
    '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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/psql/models/backup.rb', line 329

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    source_type == other.source_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    retention_period == other.retention_period &&
    backup_size == other.backup_size &&
    db_system_id == other.db_system_id &&
    db_system_details == other.db_system_details &&
    last_accepted_request_token == other.last_accepted_request_token &&
    last_completed_request_token == other.last_completed_request_token &&
    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



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

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


356
357
358
 
# File 'lib/oci/psql/models/backup.rb', line 356

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



365
366
367
 
# File 'lib/oci/psql/models/backup.rb', line 365

def hash
  [id, display_name, description, compartment_id, source_type, time_created, time_updated, lifecycle_state, lifecycle_details, retention_period, backup_size, db_system_id, db_system_details, last_accepted_request_token, last_completed_request_token, 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



409
410
411
412
413
414
415
416
417
418
 
# File 'lib/oci/psql/models/backup.rb', line 409

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



403
404
405
 
# File 'lib/oci/psql/models/backup.rb', line 403

def to_s
  to_hash.to_s
end