Class: OCI::DatabaseManagement::Models::ExternalDbSystemSummary

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

Overview

The summary of an external DB system.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalDbSystemSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 129

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


21
22
23
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 21

def compartment_id
  @compartment_id
end

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

Returns:



30
31
32
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 30

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 17

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


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

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) 


27
28
29
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 27

def home_directory
  @home_directory
end

#id ⇒ String

[Required] The OCID of the external DB system.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 13

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 38

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 34

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 42

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 46

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'home_directory': :'homeDirectory',
    'database_management_config': :'databaseManagementConfig',
    '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.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 92

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'home_directory': :'String',
    'database_management_config': :'OCI::DatabaseManagement::Models::ExternalDbSystemDatabaseManagementConfigDetails',
    '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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 211

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    home_directory == other.home_directory &&
    database_management_config == other.database_management_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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 252

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


232
233
234
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 232

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 241

def hash
  [id, display_name, compartment_id, home_directory, database_management_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



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 285

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



279
280
281
 
# File 'lib/oci/database_management/models/external_db_system_summary.rb', line 279

def to_s
  to_hash.to_s
end