Class: OCI::DatabaseManagement::Models::ExternalDbSystem

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

Overview

The details of an external DB system.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ ExternalDbSystem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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_system_discovery_id = attributes[:'dbSystemDiscoveryId'] if attributes[:'dbSystemDiscoveryId']

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

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

  self.discovery_agent_id = attributes[:'discoveryAgentId'] if attributes[:'discoveryAgentId']

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

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

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

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

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

  self.database_management_config = attributes[:'databaseManagementConfig'] if attributes[:'databaseManagementConfig']

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

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

  self.stack_monitoring_config = attributes[:'stackMonitoringConfig'] if attributes[:'stackMonitoringConfig']

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

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

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


32
33
34
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 32

def compartment_id
  @compartment_id
end

#database_management_config ⇒ OCI::DatabaseManagement::Models::ExternalDbSystemDatabaseManagementConfigDetails

Returns:



53
54
55
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 53

def database_management_config
  @database_management_config
end

#db_system_discovery_id ⇒ String

The OCID of the DB system discovery.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 36

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

Returns:

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


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

def defined_tags
  @defined_tags
end

#discovery_agent_id ⇒ String

The OCID of the management agent used during the discovery of the DB system.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 40

def discovery_agent_id
  @discovery_agent_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 28

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


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

def freeform_tags
  @freeform_tags
end

#home_directory ⇒ String

The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 50

def home_directory
  @home_directory
end

#id ⇒ String

[Required] The OCID of the external DB system.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 24

def id
  @id
end

#is_cluster ⇒ BOOLEAN

Indicates whether the DB system is a cluster DB system or not.

Returns:

  • (BOOLEAN) 


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

def is_cluster
  @is_cluster
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#stack_monitoring_config ⇒ OCI::DatabaseManagement::Models::ExternalDbSystemStackMonitoringConfigDetails

Returns:



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

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


95
96
97
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 95

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'db_system_discovery_id': :'dbSystemDiscoveryId',
    'discovery_agent_id': :'discoveryAgentId',
    'is_cluster': :'isCluster',
    'home_directory': :'homeDirectory',
    'database_management_config': :'databaseManagementConfig',
    'stack_monitoring_config': :'stackMonitoringConfig',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'db_system_discovery_id': :'String',
    'discovery_agent_id': :'String',
    'is_cluster': :'BOOLEAN',
    'home_directory': :'String',
    'database_management_config': :'OCI::DatabaseManagement::Models::ExternalDbSystemDatabaseManagementConfigDetails',
    'stack_monitoring_config': :'OCI::DatabaseManagement::Models::ExternalDbSystemStackMonitoringConfigDetails',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 286

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_system_discovery_id == other.db_system_discovery_id &&
    discovery_agent_id == other.discovery_agent_id &&
    is_cluster == other.is_cluster &&
    home_directory == other.home_directory &&
    database_management_config == other.database_management_config &&
    stack_monitoring_config == other.stack_monitoring_config &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



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

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


311
312
313
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 311

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



320
321
322
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 320

def hash
  [id, display_name, compartment_id, db_system_discovery_id, discovery_agent_id, is_cluster, home_directory, database_management_config, stack_monitoring_config, lifecycle_state, lifecycle_details, time_created, time_updated, 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



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 364

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



358
359
360
 
# File 'lib/oci/database_management/models/external_db_system.rb', line 358

def to_s
  to_hash.to_s
end