Class: OCI::Database::Models::AutonomousContainerDatabaseBackupSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/autonomous_container_database_backup_summary.rb

Overview

An Autonomous Container Database backup. To use any API operation, 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

TYPE_ENUM = 
[
  TYPE_INCREMENTAL = 'INCREMENTAL'.freeze,
  TYPE_FULL = 'FULL'.freeze,
  TYPE_VIRTUAL_FULL = 'VIRTUAL_FULL'.freeze,
  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
INFRASTRUCTURE_TYPE_ENUM = 
[
  INFRASTRUCTURE_TYPE_CLOUD = 'CLOUD'.freeze,
  INFRASTRUCTURE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'.freeze,
  INFRASTRUCTURE_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 = {}) ⇒ AutonomousContainerDatabaseBackupSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
295
296
297
298
299
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 194

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

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

  self.autonomous_container_database_id = attributes[:'autonomous_container_database_id'] if attributes[:'autonomous_container_database_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.acd_display_name = attributes[:'acdDisplayName'] if attributes[:'acdDisplayName']

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

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

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

  self.is_automatic = attributes[:'isAutomatic'] unless attributes[:'isAutomatic'].nil?

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

  self.is_automatic = attributes[:'is_automatic'] unless attributes[:'is_automatic'].nil?

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

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

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

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

  self.is_remote_backup = attributes[:'isRemoteBackup'] unless attributes[:'isRemoteBackup'].nil?

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

  self.is_remote_backup = attributes[:'is_remote_backup'] unless attributes[:'is_remote_backup'].nil?

  self.infrastructure_type = attributes[:'infrastructureType'] if attributes[:'infrastructureType']

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

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

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

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

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

Instance Attribute Details

#acd_display_name ⇒ String

The user-friendly name for the Autonomous Container Database when the Backup was initiated. This name need not be unique. This field captures the name at the time of backup creation, accounting for possible later updates to the display name.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 56

def acd_display_name
  @acd_display_name
end

#autonomous_container_database_id ⇒ String

[Required] The OCID of the Autonomous Container Database.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 48

def autonomous_container_database_id
  @autonomous_container_database_id
end

#autonomous_databases ⇒ Array<OCI::Database::Models::AutonomousDatabaseInBackup>

List of Autonomous AI Databases that is part of this Autonomous Container Database Backup

Returns:



116
117
118
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 116

def autonomous_databases
  @autonomous_databases
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 44

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

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


106
107
108
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 106

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name for the backup. This name need not be unique.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 52

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<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>) 


100
101
102
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 100

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Autonomous AI Database backup.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 40

def id
  @id
end

#infrastructure_type ⇒ String

The infrastructure type this resource belongs to.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 92

def infrastructure_type
  @infrastructure_type
end

#is_automatic ⇒ BOOLEAN

[Required] Indicates whether the backup is user-initiated or automatic.

Returns:

  • (BOOLEAN) 


64
65
66
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 64

def is_automatic
  @is_automatic
end

#is_remote_backup ⇒ BOOLEAN

Whether backup is for remote-region or local region

Returns:

  • (BOOLEAN) 


88
89
90
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 88

def is_remote_backup
  @is_remote_backup
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 76

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the backup.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 80

def lifecycle_state
  @lifecycle_state
end

#retention_period_in_days ⇒ Integer

Retention period, in days, for long-term backups

Returns:

  • (Integer) 


84
85
86
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 84

def retention_period_in_days
  @retention_period_in_days
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

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


112
113
114
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 112

def system_tags
  @system_tags
end

#time_ended ⇒ DateTime

The date and time the backup completed.

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 72

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

The date and time the backup started.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 68

def time_started
  @time_started
end

#type ⇒ String

[Required] The type of backup.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 60

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'autonomous_container_database_id': :'autonomousContainerDatabaseId',
    'display_name': :'displayName',
    'acd_display_name': :'acdDisplayName',
    'type': :'type',
    'is_automatic': :'isAutomatic',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'lifecycle_details': :'lifecycleDetails',
    'lifecycle_state': :'lifecycleState',
    'retention_period_in_days': :'retentionPeriodInDays',
    'is_remote_backup': :'isRemoteBackup',
    'infrastructure_type': :'infrastructureType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'autonomous_databases': :'autonomousDatabases'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 145

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'autonomous_container_database_id': :'String',
    'display_name': :'String',
    'acd_display_name': :'String',
    'type': :'String',
    'is_automatic': :'BOOLEAN',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'lifecycle_details': :'String',
    'lifecycle_state': :'String',
    'retention_period_in_days': :'Integer',
    'is_remote_backup': :'BOOLEAN',
    'infrastructure_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'autonomous_databases': :'Array<OCI::Database::Models::AutonomousDatabaseInBackup>'
    # 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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 347

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    autonomous_container_database_id == other.autonomous_container_database_id &&
    display_name == other.display_name &&
    acd_display_name == other.acd_display_name &&
    type == other.type &&
    is_automatic == other.is_automatic &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    lifecycle_details == other.lifecycle_details &&
    lifecycle_state == other.lifecycle_state &&
    retention_period_in_days == other.retention_period_in_days &&
    is_remote_backup == other.is_remote_backup &&
    infrastructure_type == other.infrastructure_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    autonomous_databases == other.autonomous_databases
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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 394

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


374
375
376
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 374

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



383
384
385
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 383

def hash
  [id, compartment_id, autonomous_container_database_id, display_name, acd_display_name, type, is_automatic, time_started, time_ended, lifecycle_details, lifecycle_state, retention_period_in_days, is_remote_backup, infrastructure_type, freeform_tags, defined_tags, system_tags, autonomous_databases].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 427

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



421
422
423
 
# File 'lib/oci/database/models/autonomous_container_database_backup_summary.rb', line 421

def to_s
  to_hash.to_s
end