Class: OCI::DatabaseManagement::Models::ExternalDatabaseSummary

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

Overview

The summary of an external 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
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ ExternalDatabaseSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/database_management/models/external_database_summary.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.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.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.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.external_container_database_id = attributes[:'externalContainerDatabaseId'] if attributes[:'externalContainerDatabaseId']

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

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

  self.external_db_home_id = attributes[:'externalDbHomeId'] if attributes[:'externalDbHomeId']

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

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

  self.db_system_info = attributes[:'dbSystemInfo'] if attributes[:'dbSystemInfo']

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

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

  self.db_management_config = attributes[:'dbManagementConfig'] if attributes[:'dbManagementConfig']

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

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

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

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 52

def compartment_id
  @compartment_id
end

#database_sub_type ⇒ String

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

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 66

def database_sub_type
  @database_sub_type
end

#database_type ⇒ String

The type of Oracle Database installation.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 60

def database_type
  @database_type
end

#db_management_config ⇒ OCI::DatabaseManagement::Models::DatabaseManagementConfig

Returns:



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

def db_management_config
  @db_management_config
end

#db_system_info ⇒ OCI::DatabaseManagement::Models::ExternalDbSystemBasicInfo

Returns:



79
80
81
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 79

def db_system_info
  @db_system_info
end

#db_unique_name ⇒ String

The DB_UNIQUE_NAME of the external database.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 56

def db_unique_name
  @db_unique_name
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. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the database. The name does not have to be unique.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 48

def display_name
  @display_name
end

#external_container_database_id ⇒ String

The OCID of the parent Container Database (CDB) if this is a Pluggable Database (PDB).

Returns:

  • (String) 


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

def external_container_database_id
  @external_container_database_id
end

#external_db_home_id ⇒ String

The OCID of the external DB home.

Returns:

  • (String) 


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

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


101
102
103
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 101

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the external DB system.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 44

def id
  @id
end

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

The list of database instances if the database is a RAC database.

Returns:



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

def instance_details
  @instance_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the external database resource.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
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. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


117
118
119
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 117

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the external DB system was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'db_unique_name': :'dbUniqueName',
    'database_type': :'databaseType',
    'database_sub_type': :'databaseSubType',
    'external_container_database_id': :'externalContainerDatabaseId',
    'external_db_home_id': :'externalDbHomeId',
    'db_system_info': :'dbSystemInfo',
    'db_management_config': :'dbManagementConfig',
    'instance_details': :'instanceDetails',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'db_unique_name': :'String',
    'database_type': :'String',
    'database_sub_type': :'String',
    'external_container_database_id': :'String',
    'external_db_home_id': :'String',
    'db_system_info': :'OCI::DatabaseManagement::Models::ExternalDbSystemBasicInfo',
    'db_management_config': :'OCI::DatabaseManagement::Models::DatabaseManagementConfig',
    'instance_details': :'Array<OCI::DatabaseManagement::Models::ExternalDatabaseInstance>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    '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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 334

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    db_unique_name == other.db_unique_name &&
    database_type == other.database_type &&
    database_sub_type == other.database_sub_type &&
    external_container_database_id == other.external_container_database_id &&
    external_db_home_id == other.external_db_home_id &&
    db_system_info == other.db_system_info &&
    db_management_config == other.db_management_config &&
    instance_details == other.instance_details &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 379

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


359
360
361
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 359

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



368
369
370
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 368

def hash
  [id, display_name, compartment_id, db_unique_name, database_type, database_sub_type, external_container_database_id, external_db_home_id, db_system_info, db_management_config, instance_details, lifecycle_state, time_created, 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



412
413
414
415
416
417
418
419
420
421
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 412

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



406
407
408
 
# File 'lib/oci/database_management/models/external_database_summary.rb', line 406

def to_s
  to_hash.to_s
end