Class: OCI::DatabaseManagement::Models::ManagedDatabase

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

Overview

The details of a Managed Database.

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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MANAGEMENT_OPTION_ENUM = 
[
  MANAGEMENT_OPTION_BASIC = 'BASIC'.freeze,
  MANAGEMENT_OPTION_ADVANCED = 'ADVANCED'.freeze,
  MANAGEMENT_OPTION_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
DATABASE_STATUS_ENUM = 
[
  DATABASE_STATUS_UP = 'UP'.freeze,
  DATABASE_STATUS_DOWN = 'DOWN'.freeze,
  DATABASE_STATUS_UNKNOWN = 'UNKNOWN'.freeze,
  DATABASE_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagedDatabase

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
319
320
321
322
323
324
325
326
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/database_management/models/managed_database.rb', line 251

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

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

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

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

  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.is_cluster = attributes[:'isCluster'] unless attributes[:'isCluster'].nil?

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

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

  self.parent_container_id = attributes[:'parentContainerId'] if attributes[:'parentContainerId']

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

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

  self.managed_database_groups = attributes[:'managedDatabaseGroups'] if attributes[:'managedDatabaseGroups']

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

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

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

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

  self.storage_system_id = attributes[:'storage_system_id'] if attributes[:'storage_system_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.database_status = attributes[:'databaseStatus'] if attributes[:'databaseStatus']

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

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

  self.parent_container_name = attributes[:'parentContainerName'] if attributes[:'parentContainerName']

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

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

  self.parent_container_compartment_id = attributes[:'parentContainerCompartmentId'] if attributes[:'parentContainerCompartmentId']

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

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

  self.instance_count = attributes[:'instanceCount'] if attributes[:'instanceCount']

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

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

  self.instance_details = attributes[:'instanceDetails'] if attributes[:'instanceDetails']

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

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

  self.pdb_count = attributes[:'pdbCount'] if attributes[:'pdbCount']

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

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

  self.pdb_status = attributes[:'pdbStatus'] if attributes[:'pdbStatus']

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

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

  self.additional_details = attributes[:'additionalDetails'] if attributes[:'additionalDetails']

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

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

Instance Attribute Details

#additional_details ⇒ Hash<String, String>

The additional details specific to a type of database defined in {\"key\": \"value\"} format. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


161
162
163
 
# File 'lib/oci/database_management/models/managed_database.rb', line 161

def additional_details
  @additional_details
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/database_management/models/managed_database.rb', line 68

def compartment_id
  @compartment_id
end

#database_status ⇒ String

The status of the Oracle Database. Indicates whether the status of the database is UP, DOWN, or UNKNOWN at the current time.

Returns:

  • (String) 


128
129
130
 
# File 'lib/oci/database_management/models/managed_database.rb', line 128

def database_status
  @database_status
end

#database_sub_type ⇒ String

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


82
83
84
 
# File 'lib/oci/database_management/models/managed_database.rb', line 82

def database_sub_type
  @database_sub_type
end

#database_type ⇒ String

[Required] The type of Oracle Database installation.

Returns:

  • (String) 


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

def database_type
  @database_type
end

#db_system_id ⇒ String

The OCID of the external DB system that this Managed Database is part of.

Returns:

  • (String) 


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

def db_system_id
  @db_system_id
end

#deployment_type ⇒ String

The infrastructure used to deploy the Oracle Database.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/database_management/models/managed_database.rb', line 86

def deployment_type
  @deployment_type
end

#id ⇒ String

[Required] The OCID of the Managed Database.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/database_management/models/managed_database.rb', line 64

def id
  @id
end

#instance_count ⇒ Integer

The number of Oracle Real Application Clusters (Oracle RAC) database instances.

Returns:

  • (Integer) 


143
144
145
 
# File 'lib/oci/database_management/models/managed_database.rb', line 143

def instance_count
  @instance_count
end

#instance_details ⇒ Array<OCI::DatabaseManagement::Models::InstanceDetails>

The details of the Oracle Real Application Clusters (Oracle RAC) database instances.

Returns:



147
148
149
 
# File 'lib/oci/database_management/models/managed_database.rb', line 147

def instance_details
  @instance_details
end

#is_cluster ⇒ BOOLEAN

[Required] Indicates whether the Oracle Database is part of a cluster.

Returns:

  • (BOOLEAN) 


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

def is_cluster
  @is_cluster
end

#managed_database_groups ⇒ Array<OCI::DatabaseManagement::Models::ParentGroup>

A list of Managed Database Groups that the Managed Database belongs to.

Returns:



108
109
110
 
# File 'lib/oci/database_management/models/managed_database.rb', line 108

def managed_database_groups
  @managed_database_groups
end

#management_option ⇒ String

The management option used when enabling Database Management.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/database_management/models/managed_database.rb', line 90

def management_option
  @management_option
end

#name ⇒ String

[Required] The name of the Managed Database.

Returns:

  • (String) 


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

def name
  @name
end

#parent_container_compartment_id ⇒ String

The OCID of the compartment in which the parent Container Database resides, if the Managed Database is a Pluggable Database (PDB).

Returns:

  • (String) 


139
140
141
 
# File 'lib/oci/database_management/models/managed_database.rb', line 139

def parent_container_compartment_id
  @parent_container_compartment_id
end

#parent_container_id ⇒ String

The OCID of the parent Container Database if Managed Database is a Pluggable Database.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/database_management/models/managed_database.rb', line 104

def parent_container_id
  @parent_container_id
end

#parent_container_name ⇒ String

The name of the parent Container Database.

Returns:

  • (String) 


132
133
134
 
# File 'lib/oci/database_management/models/managed_database.rb', line 132

def parent_container_name
  @parent_container_name
end

#pdb_count ⇒ Integer

The number of PDBs in the Container Database.

Returns:

  • (Integer) 


151
152
153
 
# File 'lib/oci/database_management/models/managed_database.rb', line 151

def pdb_count
  @pdb_count
end

#pdb_status ⇒ Array<OCI::DatabaseManagement::Models::PdbStatusDetails>

The status of the PDB in the Container Database.

Returns:



155
156
157
 
# File 'lib/oci/database_management/models/managed_database.rb', line 155

def pdb_status
  @pdb_status
end

#storage_system_id ⇒ String

The OCID of the storage DB system.

Returns:

  • (String) 


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

def storage_system_id
  @storage_system_id
end

#time_created ⇒ DateTime

[Required] The date and time the Managed Database was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#workload_type ⇒ String

The workload type of the Autonomous Database.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/database_management/models/managed_database.rb', line 94

def workload_type
  @workload_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'database_type': :'databaseType',
    'database_sub_type': :'databaseSubType',
    'deployment_type': :'deploymentType',
    'management_option': :'managementOption',
    'workload_type': :'workloadType',
    'is_cluster': :'isCluster',
    'parent_container_id': :'parentContainerId',
    'managed_database_groups': :'managedDatabaseGroups',
    'db_system_id': :'dbSystemId',
    'storage_system_id': :'storageSystemId',
    'time_created': :'timeCreated',
    'database_status': :'databaseStatus',
    'parent_container_name': :'parentContainerName',
    'parent_container_compartment_id': :'parentContainerCompartmentId',
    'instance_count': :'instanceCount',
    'instance_details': :'instanceDetails',
    'pdb_count': :'pdbCount',
    'pdb_status': :'pdbStatus',
    'additional_details': :'additionalDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'database_type': :'String',
    'database_sub_type': :'String',
    'deployment_type': :'String',
    'management_option': :'String',
    'workload_type': :'String',
    'is_cluster': :'BOOLEAN',
    'parent_container_id': :'String',
    'managed_database_groups': :'Array<OCI::DatabaseManagement::Models::ParentGroup>',
    'db_system_id': :'String',
    'storage_system_id': :'String',
    'time_created': :'DateTime',
    'database_status': :'String',
    'parent_container_name': :'String',
    'parent_container_compartment_id': :'String',
    'instance_count': :'Integer',
    'instance_details': :'Array<OCI::DatabaseManagement::Models::InstanceDetails>',
    'pdb_count': :'Integer',
    'pdb_status': :'Array<OCI::DatabaseManagement::Models::PdbStatusDetails>',
    'additional_details': :'Hash<String, 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



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/oci/database_management/models/managed_database.rb', line 467

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    database_type == other.database_type &&
    database_sub_type == other.database_sub_type &&
    deployment_type == other.deployment_type &&
    management_option == other.management_option &&
    workload_type == other.workload_type &&
    is_cluster == other.is_cluster &&
    parent_container_id == other.parent_container_id &&
    managed_database_groups == other.managed_database_groups &&
    db_system_id == other.db_system_id &&
    storage_system_id == other.storage_system_id &&
    time_created == other.time_created &&
    database_status == other.database_status &&
    parent_container_name == other.parent_container_name &&
    parent_container_compartment_id == other.parent_container_compartment_id &&
    instance_count == other.instance_count &&
    instance_details == other.instance_details &&
    pdb_count == other.pdb_count &&
    pdb_status == other.pdb_status &&
    additional_details == other.additional_details
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



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/oci/database_management/models/managed_database.rb', line 518

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


498
499
500
 
# File 'lib/oci/database_management/models/managed_database.rb', line 498

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



507
508
509
 
# File 'lib/oci/database_management/models/managed_database.rb', line 507

def hash
  [id, compartment_id, name, database_type, database_sub_type, deployment_type, management_option, workload_type, is_cluster, parent_container_id, managed_database_groups, db_system_id, storage_system_id, time_created, database_status, parent_container_name, parent_container_compartment_id, instance_count, instance_details, pdb_count, pdb_status, additional_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



551
552
553
554
555
556
557
558
559
560
 
# File 'lib/oci/database_management/models/managed_database.rb', line 551

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



545
546
547
 
# File 'lib/oci/database_management/models/managed_database.rb', line 545

def to_s
  to_hash.to_s
end