Class: OCI::Database::Models::DbHome

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/db_home.rb

Overview

DbHome model.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.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 = {}) ⇒ DbHome

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :last_patch_history_entry_id (String) —

    The value to assign to the #last_patch_history_entry_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :db_system_id (String) —

    The value to assign to the #db_system_id property

  • :vm_cluster_id (String) —

    The value to assign to the #vm_cluster_id property

  • :db_version (String) —

    The value to assign to the #db_version property

  • :db_home_location (String) —

    The value to assign to the #db_home_location property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property

  • :one_off_patches (Array<String>) —

    The value to assign to the #one_off_patches property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :database_software_image_id (String) —

    The value to assign to the #database_software_image_id property

  • :is_unified_auditing_enabled (BOOLEAN) —

    The value to assign to the #is_unified_auditing_enabled property



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
265
266
267
268
269
 
# File 'lib/oci/database/models/db_home.rb', line 169

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

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

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

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

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

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

  self.db_version = attributes[:'dbVersion'] if attributes[:'dbVersion']

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

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

  self.db_home_location = attributes[:'dbHomeLocation'] if attributes[:'dbHomeLocation']

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

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

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

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

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

  self.one_off_patches = attributes[:'oneOffPatches'] if attributes[:'oneOffPatches']

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

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

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

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

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

  self.is_unified_auditing_enabled = attributes[:'isUnifiedAuditingEnabled'] unless attributes[:'isUnifiedAuditingEnabled'].nil?

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

  self.is_unified_auditing_enabled = attributes[:'is_unified_auditing_enabled'] unless attributes[:'is_unified_auditing_enabled'].nil?
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database/models/db_home.rb', line 28

def compartment_id
  @compartment_id
end

#database_software_image_id ⇒ String

The database software image OCID

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/database/models/db_home.rb', line 90

def database_software_image_id
  @database_software_image_id
end

#db_home_location ⇒ String

[Required] The location of the Oracle Database Home.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database/models/db_home.rb', line 56

def db_home_location
  @db_home_location
end

#db_system_id ⇒ String

The OCID of the DB system.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database/models/db_home.rb', line 44

def db_system_id
  @db_system_id
end

#db_version ⇒ String

[Required] The Oracle Database version.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database/models/db_home.rb', line 52

def db_version
  @db_version
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.

Returns:

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


86
87
88
 
# File 'lib/oci/database/models/db_home.rb', line 86

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-provided name for the Database Home. The name does not need to be unique.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database/models/db_home.rb', line 32

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


80
81
82
 
# File 'lib/oci/database/models/db_home.rb', line 80

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Database Home.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database/models/db_home.rb', line 24

def id
  @id
end

#is_unified_auditing_enabled ⇒ BOOLEAN

Indicates whether unified autiding is enabled or not.

Returns:

  • (BOOLEAN) 


94
95
96
 
# File 'lib/oci/database/models/db_home.rb', line 94

def is_unified_auditing_enabled
  @is_unified_auditing_enabled
end

#kms_key_id ⇒ String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/database/models/db_home.rb', line 68

def kms_key_id
  @kms_key_id
end

#last_patch_history_entry_id ⇒ String

The OCID of the last patch history. This value is updated as soon as a patch operation is started.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database/models/db_home.rb', line 36

def last_patch_history_entry_id
  @last_patch_history_entry_id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database/models/db_home.rb', line 60

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Database Home.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database/models/db_home.rb', line 40

def lifecycle_state
  @lifecycle_state
end

#one_off_patches ⇒ Array<String>

List of one-off patches for Database Homes.

Returns:

  • (Array<String>) 


72
73
74
 
# File 'lib/oci/database/models/db_home.rb', line 72

def one_off_patches
  @one_off_patches
end

#time_created ⇒ DateTime

The date and time the Database Home was created.

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/database/models/db_home.rb', line 64

def time_created
  @time_created
end

#vm_cluster_id ⇒ String

The OCID of the VM cluster.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/db_home.rb', line 48

def vm_cluster_id
  @vm_cluster_id
end

Class Method Details

.attribute_map ⇒ Object

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



97
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/models/db_home.rb', line 97

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'last_patch_history_entry_id': :'lastPatchHistoryEntryId',
    'lifecycle_state': :'lifecycleState',
    'db_system_id': :'dbSystemId',
    'vm_cluster_id': :'vmClusterId',
    'db_version': :'dbVersion',
    'db_home_location': :'dbHomeLocation',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'kms_key_id': :'kmsKeyId',
    'one_off_patches': :'oneOffPatches',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'database_software_image_id': :'databaseSoftwareImageId',
    'is_unified_auditing_enabled': :'isUnifiedAuditingEnabled'
    # 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
144
 
# File 'lib/oci/database/models/db_home.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'last_patch_history_entry_id': :'String',
    'lifecycle_state': :'String',
    'db_system_id': :'String',
    'vm_cluster_id': :'String',
    'db_version': :'String',
    'db_home_location': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'kms_key_id': :'String',
    'one_off_patches': :'Array<String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'database_software_image_id': :'String',
    'is_unified_auditing_enabled': :'BOOLEAN'
    # 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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/database/models/db_home.rb', line 291

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    last_patch_history_entry_id == other.last_patch_history_entry_id &&
    lifecycle_state == other.lifecycle_state &&
    db_system_id == other.db_system_id &&
    vm_cluster_id == other.vm_cluster_id &&
    db_version == other.db_version &&
    db_home_location == other.db_home_location &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    kms_key_id == other.kms_key_id &&
    one_off_patches == other.one_off_patches &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    database_software_image_id == other.database_software_image_id &&
    is_unified_auditing_enabled == other.is_unified_auditing_enabled
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/database/models/db_home.rb', line 337

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


317
318
319
 
# File 'lib/oci/database/models/db_home.rb', line 317

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



326
327
328
 
# File 'lib/oci/database/models/db_home.rb', line 326

def hash
  [id, compartment_id, display_name, last_patch_history_entry_id, lifecycle_state, db_system_id, vm_cluster_id, db_version, db_home_location, lifecycle_details, time_created, kms_key_id, one_off_patches, freeform_tags, defined_tags, database_software_image_id, is_unified_auditing_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/oci/database/models/db_home.rb', line 370

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



364
365
366
 
# File 'lib/oci/database/models/db_home.rb', line 364

def to_s
  to_hash.to_s
end