Class: OCI::Core::Models::CreateImageDetails
- Inherits:
-
Object
- Object
- OCI::Core::Models::CreateImageDetails
- Defined in:
- lib/oci/core/models/create_image_details.rb
Overview
Either instanceId or imageSourceDetails must be provided in addition to other required parameters.
Constant Summary collapse
- LAUNCH_MODE_ENUM =
rubocop:disable Metrics/LineLength
[ LAUNCH_MODE_NATIVE = 'NATIVE'.freeze, LAUNCH_MODE_EMULATED = 'EMULATED'.freeze, LAUNCH_MODE_CUSTOM = 'CUSTOM'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the instance you want to use as the basis for the image.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name for the image.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#image_source_details ⇒ OCI::Core::Models::ImageSourceDetails
Details for creating an image through import.
-
#instance_id ⇒ String
The OCID of the instance you want to use as the basis for the image.
-
#launch_mode ⇒ String
Specifies the configuration mode for launching virtual machine (VM) instances.
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 = {}) ⇒ CreateImageDetails
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 = {}) ⇒ CreateImageDetails
Initializes the object
105 106 107 108 109 110 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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/oci/core/models/create_image_details.rb', line 105 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. = 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.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. = 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.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 |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the instance you want to use as the basis for the image.
17 18 19 |
# File 'lib/oci/core/models/create_image_details.rb', line 17 def compartment_id @compartment_id 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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
25 26 27 |
# File 'lib/oci/core/models/create_image_details.rb', line 25 def @defined_tags end |
#display_name ⇒ 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 an Oracle-provided image name as a custom image name.
Example: ‘My Oracle Linux image`
35 36 37 |
# File 'lib/oci/core/models/create_image_details.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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
44 45 46 |
# File 'lib/oci/core/models/create_image_details.rb', line 44 def @freeform_tags end |
#image_source_details ⇒ OCI::Core::Models::ImageSourceDetails
Details for creating an image through import
48 49 50 |
# File 'lib/oci/core/models/create_image_details.rb', line 48 def image_source_details @image_source_details end |
#instance_id ⇒ String
The OCID of the instance you want to use as the basis for the image.
52 53 54 |
# File 'lib/oci/core/models/create_image_details.rb', line 52 def instance_id @instance_id end |
#launch_mode ⇒ String
Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
-
‘NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for Oracle-provided images.
-
‘EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
-
‘CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
60 61 62 |
# File 'lib/oci/core/models/create_image_details.rb', line 60 def launch_mode @launch_mode end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/oci/core/models/create_image_details.rb', line 63 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 |
.swagger_types ⇒ Object
Attribute type mapping.
78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/oci/core/models/create_image_details.rb', line 78 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 |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/oci/core/models/create_image_details.rb', line 170 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && display_name == other.display_name && == other. && image_source_details == other.image_source_details && instance_id == other.instance_id && launch_mode == other.launch_mode end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/oci/core/models/create_image_details.rb', line 205 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
185 186 187 |
# File 'lib/oci/core/models/create_image_details.rb', line 185 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
194 195 196 |
# File 'lib/oci/core/models/create_image_details.rb', line 194 def hash [compartment_id, , display_name, , image_source_details, instance_id, launch_mode].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
237 238 239 240 241 242 243 244 245 |
# File 'lib/oci/core/models/create_image_details.rb', line 237 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
231 232 233 |
# File 'lib/oci/core/models/create_image_details.rb', line 231 def to_s to_hash.to_s end |