Class: OCI::DatabaseManagement::Models::DatabaseHaBackupDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/database_ha_backup_details.rb

Overview

The database HA and backup details.

Constant Summary collapse

DATABASE_TYPE_ENUM =
[
  DATABASE_TYPE_EXTERNAL_SIDB = 'EXTERNAL_SIDB'.freeze,
  DATABASE_TYPE_EXTERNAL_RAC = 'EXTERNAL_RAC'.freeze,
  DATABASE_TYPE_CLOUD_SIDB = 'CLOUD_SIDB'.freeze,
  DATABASE_TYPE_CLOUD_RAC = 'CLOUD_RAC'.freeze,
  DATABASE_TYPE_SHARED = 'SHARED'.freeze,
  DATABASE_TYPE_DEDICATED = 'DEDICATED'.freeze,
  DATABASE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_SUB_TYPE_ENUM =
[
  DATABASE_SUB_TYPE_CDB = 'CDB'.freeze,
  DATABASE_SUB_TYPE_PDB = 'PDB'.freeze,
  DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'.freeze,
  DATABASE_SUB_TYPE_ACD = 'ACD'.freeze,
  DATABASE_SUB_TYPE_ADB = 'ADB'.freeze,
  DATABASE_SUB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DEPLOYMENT_TYPE_ENUM =
[
  DEPLOYMENT_TYPE_ONPREMISE = 'ONPREMISE'.freeze,
  DEPLOYMENT_TYPE_BM = 'BM'.freeze,
  DEPLOYMENT_TYPE_VM = 'VM'.freeze,
  DEPLOYMENT_TYPE_EXADATA = 'EXADATA'.freeze,
  DEPLOYMENT_TYPE_EXADATA_CC = 'EXADATA_CC'.freeze,
  DEPLOYMENT_TYPE_AUTONOMOUS = 'AUTONOMOUS'.freeze,
  DEPLOYMENT_TYPE_EXADATA_XS = 'EXADATA_XS'.freeze,
  DEPLOYMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
WORKLOAD_TYPE_ENUM =
[
  WORKLOAD_TYPE_OLTP = 'OLTP'.freeze,
  WORKLOAD_TYPE_DW = 'DW'.freeze,
  WORKLOAD_TYPE_AJD = 'AJD'.freeze,
  WORKLOAD_TYPE_APEX = 'APEX'.freeze,
  WORKLOAD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DB_ROLE_ENUM =
[
  DB_ROLE_SNAPSHOT_STANDBY = 'SNAPSHOT_STANDBY'.freeze,
  DB_ROLE_LOGICAL_STANDBY = 'LOGICAL_STANDBY'.freeze,
  DB_ROLE_PHYSICAL_STANDBY = 'PHYSICAL_STANDBY'.freeze,
  DB_ROLE_PRIMARY = 'PRIMARY'.freeze,
  DB_ROLE_FAR_SYNC = 'FAR_SYNC'.freeze,
  DB_ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseHaBackupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 201

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

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

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

  self.flash_back_time = attributes[:'flashBackTime'] if attributes[:'flashBackTime']

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

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

  self.recovery_window_goal_in_days = attributes[:'recoveryWindowGoalInDays'] if attributes[:'recoveryWindowGoalInDays']

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

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

  self.last_full_backup_summary = attributes[:'lastFullBackupSummary'] if attributes[:'lastFullBackupSummary']

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

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

  self.backup_history = attributes[:'backupHistory'] if attributes[:'backupHistory']

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

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

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

  self.db_id = attributes[:'dbId'] if attributes[:'dbId']

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

  self.db_id = attributes[:'db_id'] if attributes[:'db_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.database_type = attributes[:'databaseType'] if attributes[:'databaseType']

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

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

  self.database_sub_type = attributes[:'databaseSubType'] if attributes[:'databaseSubType']

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

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

  self.deployment_type = attributes[:'deploymentType'] if attributes[:'deploymentType']

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

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

  self.database_version = attributes[:'databaseVersion'] if attributes[:'databaseVersion']

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

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

  self.workload_type = attributes[:'workloadType'] if attributes[:'workloadType']

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

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

  self.database_name = attributes[:'databaseName'] if attributes[:'databaseName']

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

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

  self.database_id = attributes[:'databaseId'] if attributes[:'databaseId']

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

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

  self.db_unique_name = attributes[:'dbUniqueName'] if attributes[:'dbUniqueName']

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

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

  self.db_role = attributes[:'dbRole'] if attributes[:'dbRole']

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

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

Instance Attribute Details

#backup_historyArray<OCI::DatabaseManagement::Models::DatabaseBackupSummary>

A list of database backups.



76
77
78
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 76

def backup_history
  @backup_history
end

#compartment_idString

[Required] The OCID of the compartment where the Managed Database resides.

Returns:

  • (String)


88
89
90
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 88

def compartment_id
  @compartment_id
end

#database_idString

The database ID of the Managed Database. Every database had its own ID and that value is captured here.

Returns:

  • (String)


118
119
120
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 118

def database_id
  @database_id
end

#database_nameString

[Required] The display name of the Managed Database.

Returns:

  • (String)


114
115
116
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 114

def database_name
  @database_name
end

#database_sub_typeString

[Required] The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.

Returns:

  • (String)


98
99
100
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 98

def database_sub_type
  @database_sub_type
end

#database_typeString

[Required] The type of Oracle Database installation.

Returns:

  • (String)


92
93
94
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 92

def database_type
  @database_type
end

#database_versionString

The Oracle Database version.

Returns:

  • (String)


106
107
108
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 106

def database_version
  @database_version
end

#db_idString

[Required] The OCID of the Managed Database.

Returns:

  • (String)


84
85
86
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 84

def db_id
  @db_id
end

#db_roleString

[Required] The database role of the Managed Database.

Returns:

  • (String)


126
127
128
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 126

def db_role
  @db_role
end

#db_unique_nameString

The database unique name of the Managed Database.

Returns:

  • (String)


122
123
124
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 122

def db_unique_name
  @db_unique_name
end

#deployment_typeString

[Required] The infrastructure used to deploy the Oracle Database.

Returns:

  • (String)


102
103
104
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 102

def deployment_type
  @deployment_type
end

#flash_back_onString

Indicates whether flashback is enabled for the database.

Returns:

  • (String)


61
62
63
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 61

def flash_back_on
  @flash_back_on
end

#flash_back_timeDateTime

The oldest flashback date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

Returns:

  • (DateTime)


65
66
67
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 65

def flash_back_time
  @flash_back_time
end

#last_full_backup_summaryOCI::DatabaseManagement::Models::DatabaseBackupSummary



72
73
74
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 72

def last_full_backup_summary
  @last_full_backup_summary
end

#metricsArray<OCI::DatabaseManagement::Models::HaMetricDefinition>

A list of database backup metrics such as BackupSize and BackupDuration.



80
81
82
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 80

def metrics
  @metrics
end

#recovery_window_goal_in_daysInteger

The configured number of days intended to recover a protected database from a backup.

Returns:

  • (Integer)


69
70
71
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 69

def recovery_window_goal_in_days
  @recovery_window_goal_in_days
end

#workload_typeString

The workload type of the Autonomous Database.

Returns:

  • (String)


110
111
112
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 110

def workload_type
  @workload_type
end

Class Method Details

.attribute_mapObject

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 129

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'flash_back_on': :'flashBackOn',
    'flash_back_time': :'flashBackTime',
    'recovery_window_goal_in_days': :'recoveryWindowGoalInDays',
    'last_full_backup_summary': :'lastFullBackupSummary',
    'backup_history': :'backupHistory',
    'metrics': :'metrics',
    'db_id': :'dbId',
    'compartment_id': :'compartmentId',
    'database_type': :'databaseType',
    'database_sub_type': :'databaseSubType',
    'deployment_type': :'deploymentType',
    'database_version': :'databaseVersion',
    'workload_type': :'workloadType',
    'database_name': :'databaseName',
    'database_id': :'databaseId',
    'db_unique_name': :'dbUniqueName',
    'db_role': :'dbRole'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 154

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'flash_back_on': :'String',
    'flash_back_time': :'DateTime',
    'recovery_window_goal_in_days': :'Integer',
    'last_full_backup_summary': :'OCI::DatabaseManagement::Models::DatabaseBackupSummary',
    'backup_history': :'Array<OCI::DatabaseManagement::Models::DatabaseBackupSummary>',
    'metrics': :'Array<OCI::DatabaseManagement::Models::HaMetricDefinition>',
    'db_id': :'String',
    'compartment_id': :'String',
    'database_type': :'String',
    'database_sub_type': :'String',
    'deployment_type': :'String',
    'database_version': :'String',
    'workload_type': :'String',
    'database_name': :'String',
    'database_id': :'String',
    'db_unique_name': :'String',
    'db_role': :'String'
    # 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



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/database_management/models/database_ha_backup_details.rb', line 378

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

  self.class == other.class &&
    flash_back_on == other.flash_back_on &&
    flash_back_time == other.flash_back_time &&
    recovery_window_goal_in_days == other.recovery_window_goal_in_days &&
    last_full_backup_summary == other.last_full_backup_summary &&
    backup_history == other.backup_history &&
    metrics == other.metrics &&
    db_id == other.db_id &&
    compartment_id == other.compartment_id &&
    database_type == other.database_type &&
    database_sub_type == other.database_sub_type &&
    deployment_type == other.deployment_type &&
    database_version == other.database_version &&
    workload_type == other.workload_type &&
    database_name == other.database_name &&
    database_id == other.database_id &&
    db_unique_name == other.db_unique_name &&
    db_role == other.db_role
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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 424

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


404
405
406
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 404

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



413
414
415
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 413

def hash
  [flash_back_on, flash_back_time, recovery_window_goal_in_days, last_full_backup_summary, backup_history, metrics, db_id, compartment_id, database_type, database_sub_type, deployment_type, database_version, workload_type, database_name, database_id, db_unique_name, db_role].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



457
458
459
460
461
462
463
464
465
466
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 457

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



451
452
453
# File 'lib/oci/database_management/models/database_ha_backup_details.rb', line 451

def to_s
  to_hash.to_s
end