class OCI::Core::Models::CreateImageDetails
Either instanceId or imageSourceDetails must be provided in addition to other required parameters.
Constants
- LAUNCH_MODE_ENUM
Attributes
[Required] The OCID of the compartment you want the image to be created in. @return [String]
A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.
You cannot use a platform image name as a custom image name.
Example: `My Oracle Linux image`
@return [String]
@return [OCI::Core::Models::ImageSourceDetails]
The OCID of the instance you want to use as the basis for the image.
@return [String]
Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
-
`NATIVE` - VM instances launch with paravirtualized boot and VFIO devices. The default value for platform images.
-
`EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
-
`PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.
-
`CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/create_image_details.rb, line 66 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'image_source_details': :'imageSourceDetails', 'instance_id': :'instanceId', 'launch_mode': :'launchMode' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [OCI::Core::Models::ImageSourceDetails] :image_source_details The value to assign to the {#image_source_details} property @option attributes [String] :instance_id The value to assign to the {#instance_id} property @option attributes [String] :launch_mode The value to assign to the {#launch_mode} property
# File lib/oci/core/models/create_image_details.rb, line 108 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.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.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.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.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.image_source_details = attributes[:'imageSourceDetails'] if attributes[:'imageSourceDetails'] raise 'You cannot provide both :imageSourceDetails and :image_source_details' if attributes.key?(:'imageSourceDetails') && attributes.key?(:'image_source_details') self.image_source_details = attributes[:'image_source_details'] if attributes[:'image_source_details'] self.instance_id = attributes[:'instanceId'] if attributes[:'instanceId'] raise 'You cannot provide both :instanceId and :instance_id' if attributes.key?(:'instanceId') && attributes.key?(:'instance_id') self.instance_id = attributes[:'instance_id'] if attributes[:'instance_id'] self.launch_mode = attributes[:'launchMode'] if attributes[:'launchMode'] raise 'You cannot provide both :launchMode and :launch_mode' if attributes.key?(:'launchMode') && attributes.key?(:'launch_mode') self.launch_mode = attributes[:'launch_mode'] if attributes[:'launch_mode'] end
Attribute type mapping.
# File lib/oci/core/models/create_image_details.rb, line 81 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'image_source_details': :'OCI::Core::Models::ImageSourceDetails', 'instance_id': :'String', 'launch_mode': :'String' # 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/core/models/create_image_details.rb, line 172 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && defined_tags == other.defined_tags && display_name == other.display_name && freeform_tags == other.freeform_tags && image_source_details == other.image_source_details && instance_id == other.instance_id && launch_mode == other.launch_mode 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/core/models/create_image_details.rb, line 208 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/core/models/create_image_details.rb, line 188 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/create_image_details.rb, line 197 def hash [compartment_id, defined_tags, display_name, freeform_tags, image_source_details, instance_id, launch_mode].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] launch_mode
Object
to be assigned
# File lib/oci/core/models/create_image_details.rb, line 161 def launch_mode=(launch_mode) raise "Invalid value for 'launch_mode': this must be one of the values in LAUNCH_MODE_ENUM." if launch_mode && !LAUNCH_MODE_ENUM.include?(launch_mode) @launch_mode = launch_mode end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/create_image_details.rb, line 241 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/core/models/create_image_details.rb, line 235 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/core/models/create_image_details.rb, line 258 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