class OCI::Database::Models::DatabaseSoftwareImageSummary
The Database
service supports the creation of database software images for use in creating and patching DB systems and databases.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
For information about access control and compartments, see [Overview of the Identity
Service](docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Constants
- IMAGE_SHAPE_FAMILY_ENUM
- IMAGE_TYPE_ENUM
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. @return [String]
List of one-off patches for Database
Homes. @return [Array<String>]
List of one-off patches for Database
Homes. @return [Array<String>]
[Required] The database version with which the database software image is to be built. @return [String]
[Required] The user-friendly name for the database software image. The name does not have to be unique. @return [String]
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database software image. @return [String]
[Required] To what shape the image is meant for. @return [String]
[Required] The type of software image. Can be grid or database. @return [String]
The patches included in the image and the version of the image @return [String]
True if this Database
software image is supported for Upgrade. @return [BOOLEAN]
Detailed message for the lifecycle state. @return [String]
[Required] The current state of the database software image. @return [String]
output from lsinventory which will get passed as a string @return [String]
[Required] The PSU or PBP or Release Updates. To get a list of supported versions, use the {#list_db_versions list_db_versions} operation. @return [String]
[Required] The date and time the database software image was created. @return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/database/models/database_software_image_summary.rb, line 118 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'database_version': :'databaseVersion', 'display_name': :'displayName', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'time_created': :'timeCreated', 'image_type': :'imageType', 'image_shape_family': :'imageShapeFamily', 'patch_set': :'patchSet', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'database_software_image_included_patches': :'databaseSoftwareImageIncludedPatches', 'included_patches_summary': :'includedPatchesSummary', 'database_software_image_one_off_patches': :'databaseSoftwareImageOneOffPatches', 'ls_inventory': :'lsInventory', 'is_upgrade_supported': :'isUpgradeSupported' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :database_version The value to assign to the {#database_version} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifecycle_details The value to assign to the {#lifecycle_details} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :image_type The value to assign to the {#image_type} property @option attributes [String] :image_shape_family The value to assign to the {#image_shape_family} property @option attributes [String] :patch_set The value to assign to the {#patch_set} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Array<String>] :database_software_image_included_patches The value to assign to the {#database_software_image_included_patches} property @option attributes [String] :included_patches_summary The value to assign to the {#included_patches_summary} property @option attributes [Array<String>] :database_software_image_one_off_patches The value to assign to the {#database_software_image_one_off_patches} property @option attributes [String] :ls_inventory The value to assign to the {#ls_inventory} property @option attributes [BOOLEAN] :is_upgrade_supported The value to assign to the {#is_upgrade_supported} property
# File lib/oci/database/models/database_software_image_summary.rb, line 190 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.database_version = attributes[:'databaseVersion'] if attributes[:'databaseVersion'] raise 'You cannot provide both :databaseVersion and :database_version' if attributes.key?(:'databaseVersion') && attributes.key?(:'database_version') self.database_version = attributes[:'database_version'] if attributes[:'database_version'] 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.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.image_type = attributes[:'imageType'] if attributes[:'imageType'] raise 'You cannot provide both :imageType and :image_type' if attributes.key?(:'imageType') && attributes.key?(:'image_type') self.image_type = attributes[:'image_type'] if attributes[:'image_type'] self.image_shape_family = attributes[:'imageShapeFamily'] if attributes[:'imageShapeFamily'] raise 'You cannot provide both :imageShapeFamily and :image_shape_family' if attributes.key?(:'imageShapeFamily') && attributes.key?(:'image_shape_family') self.image_shape_family = attributes[:'image_shape_family'] if attributes[:'image_shape_family'] self.patch_set = attributes[:'patchSet'] if attributes[:'patchSet'] raise 'You cannot provide both :patchSet and :patch_set' if attributes.key?(:'patchSet') && attributes.key?(:'patch_set') self.patch_set = attributes[:'patch_set'] if attributes[:'patch_set'] 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_included_patches = attributes[:'databaseSoftwareImageIncludedPatches'] if attributes[:'databaseSoftwareImageIncludedPatches'] raise 'You cannot provide both :databaseSoftwareImageIncludedPatches and :database_software_image_included_patches' if attributes.key?(:'databaseSoftwareImageIncludedPatches') && attributes.key?(:'database_software_image_included_patches') self.database_software_image_included_patches = attributes[:'database_software_image_included_patches'] if attributes[:'database_software_image_included_patches'] self.included_patches_summary = attributes[:'includedPatchesSummary'] if attributes[:'includedPatchesSummary'] raise 'You cannot provide both :includedPatchesSummary and :included_patches_summary' if attributes.key?(:'includedPatchesSummary') && attributes.key?(:'included_patches_summary') self.included_patches_summary = attributes[:'included_patches_summary'] if attributes[:'included_patches_summary'] self.database_software_image_one_off_patches = attributes[:'databaseSoftwareImageOneOffPatches'] if attributes[:'databaseSoftwareImageOneOffPatches'] raise 'You cannot provide both :databaseSoftwareImageOneOffPatches and :database_software_image_one_off_patches' if attributes.key?(:'databaseSoftwareImageOneOffPatches') && attributes.key?(:'database_software_image_one_off_patches') self.database_software_image_one_off_patches = attributes[:'database_software_image_one_off_patches'] if attributes[:'database_software_image_one_off_patches'] self.ls_inventory = attributes[:'lsInventory'] if attributes[:'lsInventory'] raise 'You cannot provide both :lsInventory and :ls_inventory' if attributes.key?(:'lsInventory') && attributes.key?(:'ls_inventory') self.ls_inventory = attributes[:'ls_inventory'] if attributes[:'ls_inventory'] self.is_upgrade_supported = attributes[:'isUpgradeSupported'] unless attributes[:'isUpgradeSupported'].nil? raise 'You cannot provide both :isUpgradeSupported and :is_upgrade_supported' if attributes.key?(:'isUpgradeSupported') && attributes.key?(:'is_upgrade_supported') self.is_upgrade_supported = attributes[:'is_upgrade_supported'] unless attributes[:'is_upgrade_supported'].nil? end
Attribute type mapping.
# File lib/oci/database/models/database_software_image_summary.rb, line 143 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'database_version': :'String', 'display_name': :'String', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'time_created': :'DateTime', 'image_type': :'String', 'image_shape_family': :'String', 'patch_set': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'database_software_image_included_patches': :'Array<String>', 'included_patches_summary': :'String', 'database_software_image_one_off_patches': :'Array<String>', 'ls_inventory': :'String', 'is_upgrade_supported': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/database/models/database_software_image_summary.rb, line 341 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && database_version == other.database_version && display_name == other.display_name && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && time_created == other.time_created && image_type == other.image_type && image_shape_family == other.image_shape_family && patch_set == other.patch_set && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && database_software_image_included_patches == other.database_software_image_included_patches && included_patches_summary == other.included_patches_summary && database_software_image_one_off_patches == other.database_software_image_one_off_patches && ls_inventory == other.ls_inventory && is_upgrade_supported == other.is_upgrade_supported end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/database/models/database_software_image_summary.rb, line 387 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/database/models/database_software_image_summary.rb, line 367 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/database/models/database_software_image_summary.rb, line 376 def hash [id, compartment_id, database_version, display_name, lifecycle_state, lifecycle_details, time_created, image_type, image_shape_family, patch_set, freeform_tags, defined_tags, database_software_image_included_patches, included_patches_summary, database_software_image_one_off_patches, ls_inventory, is_upgrade_supported].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] image_shape_family
Object
to be assigned
# File lib/oci/database/models/database_software_image_summary.rb, line 325 def image_shape_family=(image_shape_family) # rubocop:disable Style/ConditionalAssignment if image_shape_family && !IMAGE_SHAPE_FAMILY_ENUM.include?(image_shape_family) OCI.logger.debug("Unknown value for 'image_shape_family' [" + image_shape_family + "]. Mapping to 'IMAGE_SHAPE_FAMILY_UNKNOWN_ENUM_VALUE'") if OCI.logger @image_shape_family = IMAGE_SHAPE_FAMILY_UNKNOWN_ENUM_VALUE else @image_shape_family = image_shape_family end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] image_type
Object
to be assigned
# File lib/oci/database/models/database_software_image_summary.rb, line 312 def image_type=(image_type) # rubocop:disable Style/ConditionalAssignment if image_type && !IMAGE_TYPE_ENUM.include?(image_type) OCI.logger.debug("Unknown value for 'image_type' [" + image_type + "]. Mapping to 'IMAGE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @image_type = IMAGE_TYPE_UNKNOWN_ENUM_VALUE else @image_type = image_type end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/database/models/database_software_image_summary.rb, line 299 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/database/models/database_software_image_summary.rb, line 420 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/database/models/database_software_image_summary.rb, line 414 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/database/models/database_software_image_summary.rb, line 437 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end