Class: OCI::Database::Models::DbHomeFromAgentResourceId

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

Overview

DbHomeFromAgentResourceId 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
].freeze
HOME_TYPE_ENUM = 
[
  HOME_TYPE_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  HOME_TYPE_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbHomeFromAgentResourceId

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

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

    The value to assign to the #system_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

  • :home_type (String) —

    The value to assign to the #home_type property



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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 189

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

  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?

  self.home_type = attributes[:'homeType'] if attributes[:'homeType']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 31

def compartment_id
  @compartment_id
end

#database_software_image_id ⇒ String

The database software image OCID

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 99

def database_software_image_id
  @database_software_image_id
end

#db_home_location ⇒ String

[Required] The location of the Oracle Database Home.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 59

def db_home_location
  @db_home_location
end

#db_system_id ⇒ String

The OCID of the DB system.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 47

def db_system_id
  @db_system_id
end

#db_version ⇒ String

[Required] The Oracle Database version.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 55

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


89
90
91
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 89

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) 


35
36
37
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 35

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


83
84
85
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 83

def freeform_tags
  @freeform_tags
end

#home_type ⇒ String

Represents database home will be managed by oracle or customer

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 108

def home_type
  @home_type
end

#id ⇒ String

[Required] The OCID of the Database Home.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 27

def id
  @id
end

#is_unified_auditing_enabled ⇒ BOOLEAN

Indicates whether unified autiding is enabled or not.

Returns:

  • (BOOLEAN) 


103
104
105
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 103

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) 


71
72
73
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 71

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) 


39
40
41
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 39

def last_patch_history_entry_id
  @last_patch_history_entry_id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 63

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Database Home.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#one_off_patches ⇒ Array<String>

List of one-off patches for Database Homes.

Returns:

  • (Array<String>) 


75
76
77
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 75

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

Returns:

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


95
96
97
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 95

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the Database Home was created.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 67

def time_created
  @time_created
end

#vm_cluster_id ⇒ String

The OCID of the VM cluster.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 51

def vm_cluster_id
  @vm_cluster_id
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 111

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',
    'system_tags': :'systemTags',
    'database_software_image_id': :'databaseSoftwareImageId',
    'is_unified_auditing_enabled': :'isUnifiedAuditingEnabled',
    'home_type': :'homeType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 138

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>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'database_software_image_id': :'String',
    'is_unified_auditing_enabled': :'BOOLEAN',
    'home_type': :'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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 326

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 &&
    system_tags == other.system_tags &&
    database_software_image_id == other.database_software_image_id &&
    is_unified_auditing_enabled == other.is_unified_auditing_enabled &&
    home_type == other.home_type
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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 374

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


354
355
356
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 354

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



363
364
365
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 363

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, system_tags, database_software_image_id, is_unified_auditing_enabled, home_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 407

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



401
402
403
 
# File 'lib/oci/database/models/db_home_from_agent_resource_id.rb', line 401

def to_s
  to_hash.to_s
end