Class: OCI::Database::Models::DbHomeSummary
- Inherits:
-
Object
- Object
- OCI::Database::Models::DbHomeSummary
- Defined in:
- lib/oci/database/models/db_home_summary.rb
Overview
A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. For more information, see Bare Metal and Virtual Machine DB Systems and Exadata DB Systems.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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
-
#compartment_id ⇒ String
[Required] The OCID of the compartment.
-
#database_software_image_id ⇒ String
The database software image OCID.
-
#db_home_location ⇒ String
[Required] The location of the Oracle Database Home.
-
#db_system_id ⇒ String
The OCID of the DB system.
-
#db_version ⇒ String
[Required] The Oracle Database version.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] The user-provided name for the Database Home.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the Database Home.
-
#is_unified_auditing_enabled ⇒ BOOLEAN
Indicates whether unified autiding is enabled or not.
-
#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.
-
#last_patch_history_entry_id ⇒ String
The OCID of the last patch history.
-
#lifecycle_details ⇒ String
Additional information about the current lifecycle state.
-
#lifecycle_state ⇒ String
[Required] The current state of the Database Home.
-
#one_off_patches ⇒ Array<String>
List of one-off patches for Database Homes.
-
#time_created ⇒ DateTime
The date and time the Database Home was created.
-
#vm_cluster_id ⇒ String
The OCID of the VM cluster.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DbHomeSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ DbHomeSummary
Initializes the object
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 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/oci/database/models/db_home_summary.rb', line 178 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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.
37 38 39 |
# File 'lib/oci/database/models/db_home_summary.rb', line 37 def compartment_id @compartment_id end |
#database_software_image_id ⇒ String
The database software image OCID
99 100 101 |
# File 'lib/oci/database/models/db_home_summary.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.
65 66 67 |
# File 'lib/oci/database/models/db_home_summary.rb', line 65 def db_home_location @db_home_location end |
#db_system_id ⇒ String
The OCID of the DB system.
53 54 55 |
# File 'lib/oci/database/models/db_home_summary.rb', line 53 def db_system_id @db_system_id end |
#db_version ⇒ String
[Required] The Oracle Database version.
61 62 63 |
# File 'lib/oci/database/models/db_home_summary.rb', line 61 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.
95 96 97 |
# File 'lib/oci/database/models/db_home_summary.rb', line 95 def @defined_tags end |
#display_name ⇒ String
[Required] The user-provided name for the Database Home. The name does not need to be unique.
41 42 43 |
# File 'lib/oci/database/models/db_home_summary.rb', line 41 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\"}
89 90 91 |
# File 'lib/oci/database/models/db_home_summary.rb', line 89 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the Database Home.
33 34 35 |
# File 'lib/oci/database/models/db_home_summary.rb', line 33 def id @id end |
#is_unified_auditing_enabled ⇒ BOOLEAN
Indicates whether unified autiding is enabled or not.
103 104 105 |
# File 'lib/oci/database/models/db_home_summary.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.
77 78 79 |
# File 'lib/oci/database/models/db_home_summary.rb', line 77 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.
45 46 47 |
# File 'lib/oci/database/models/db_home_summary.rb', line 45 def last_patch_history_entry_id @last_patch_history_entry_id end |
#lifecycle_details ⇒ String
Additional information about the current lifecycle state.
69 70 71 |
# File 'lib/oci/database/models/db_home_summary.rb', line 69 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the Database Home.
49 50 51 |
# File 'lib/oci/database/models/db_home_summary.rb', line 49 def lifecycle_state @lifecycle_state end |
#one_off_patches ⇒ Array<String>
List of one-off patches for Database Homes.
81 82 83 |
# File 'lib/oci/database/models/db_home_summary.rb', line 81 def one_off_patches @one_off_patches end |
#time_created ⇒ DateTime
The date and time the Database Home was created.
73 74 75 |
# File 'lib/oci/database/models/db_home_summary.rb', line 73 def time_created @time_created end |
#vm_cluster_id ⇒ String
The OCID of the VM cluster.
57 58 59 |
# File 'lib/oci/database/models/db_home_summary.rb', line 57 def vm_cluster_id @vm_cluster_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/oci/database/models/db_home_summary.rb', line 106 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.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/oci/database/models/db_home_summary.rb', line 131 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.
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/oci/database/models/db_home_summary.rb', line 303 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 && == other. && == other. && 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
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/oci/database/models/db_home_summary.rb', line 349 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
329 330 331 |
# File 'lib/oci/database/models/db_home_summary.rb', line 329 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
338 339 340 |
# File 'lib/oci/database/models/db_home_summary.rb', line 338 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, , , database_software_image_id, is_unified_auditing_enabled].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
382 383 384 385 386 387 388 389 390 391 |
# File 'lib/oci/database/models/db_home_summary.rb', line 382 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
376 377 378 |
# File 'lib/oci/database/models/db_home_summary.rb', line 376 def to_s to_hash.to_s end |