Class: OCI::Core::Models::Image

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/image.rb

Overview

A boot disk image for launching an instance. For more information, see [Overview of the Compute Service](docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm).

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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

LAUNCH_MODE_ENUM = 
[LAUNCH_MODE_NATIVE = 'NATIVE',
LAUNCH_MODE_EMULATED = 'EMULATED',
LAUNCH_MODE_CUSTOM = 'CUSTOM',
LAUNCH_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_IMPORTING = 'IMPORTING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_EXPORTING = 'EXPORTING',
LIFECYCLE_STATE_DISABLED = 'DISABLED',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Image

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :base_image_id (String) —

    The value to assign to the #base_image_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :create_image_allowed (BOOLEAN) —

    The value to assign to the #create_image_allowed property

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

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :id (String) —

    The value to assign to the #id property

  • :launch_mode (String) —

    The value to assign to the #launch_mode property

  • :launch_options (OCI::Core::Models::LaunchOptions) —

    The value to assign to the #launch_options property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :operating_system (String) —

    The value to assign to the #operating_system property

  • :operating_system_version (String) —

    The value to assign to the #operating_system_version property

  • :size_in_mbs (Integer) —

    The value to assign to the #size_in_mbs property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



135
136
137
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
 
# File 'lib/oci/core/models/image.rb', line 135

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}

  if attributes[:'baseImageId']
    self.base_image_id = attributes[:'baseImageId']
  end

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

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  unless attributes[:'createImageAllowed'].nil?
    self.create_image_allowed = attributes[:'createImageAllowed']
  end

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

  unless attributes[:'create_image_allowed'].nil?
    self.create_image_allowed = attributes[:'create_image_allowed']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

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

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

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

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

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

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

  if attributes[:'launchMode']
    self.launch_mode = attributes[:'launchMode']
  end

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

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

  if attributes[:'launchOptions']
    self.launch_options = attributes[:'launchOptions']
  end

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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

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

  if attributes[:'operatingSystem']
    self.operating_system = attributes[:'operatingSystem']
  end

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

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

  if attributes[:'operatingSystemVersion']
    self.operating_system_version = attributes[:'operatingSystemVersion']
  end

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

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

  if attributes[:'sizeInMBs']
    self.size_in_mbs = attributes[:'sizeInMBs']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

end

Instance Attribute Details

#base_image_id ⇒ String

The OCID of the image originally used to launch the instance.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/core/models/image.rb', line 31

def base_image_id
  @base_image_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the instance you want to use as the basis for the image.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/core/models/image.rb', line 36

def compartment_id
  @compartment_id
end

#create_image_allowed ⇒ BOOLEAN

[Required] Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: ‘true`

Returns:

  • (BOOLEAN) 


43
44
45
 
# File 'lib/oci/core/models/image.rb', line 43

def create_image_allowed
  @create_image_allowed
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"}`

Returns:

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


51
52
53
 
# File 'lib/oci/core/models/image.rb', line 51

def defined_tags
  @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 custom Oracle Linux image`

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/core/models/image.rb', line 60

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"`

Returns:

  • (Hash<String, String>) 


69
70
71
 
# File 'lib/oci/core/models/image.rb', line 69

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the image.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/core/models/image.rb', line 73

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

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/core/models/image.rb', line 81

def launch_mode
  @launch_mode
end

#launch_options ⇒ OCI::Core::Models::LaunchOptions

Returns:



84
85
86
 
# File 'lib/oci/core/models/image.rb', line 84

def launch_options
  @launch_options
end

#lifecycle_state ⇒ String

This attribute is required.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/core/models/image.rb', line 88

def lifecycle_state
  @lifecycle_state
end

#operating_system ⇒ String

[Required] The image’s operating system.

Example: ‘Oracle Linux`

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/core/models/image.rb', line 95

def operating_system
  @operating_system
end

#operating_system_version ⇒ String

[Required] The image’s operating system version.

Example: ‘7.2`

Returns:

  • (String) 


102
103
104
 
# File 'lib/oci/core/models/image.rb', line 102

def operating_system_version
  @operating_system_version
end

#size_in_mbs ⇒ Integer

Image size (1 MB = 1048576 bytes)

Example: ‘47694`

Returns:

  • (Integer) 


109
110
111
 
# File 'lib/oci/core/models/image.rb', line 109

def size_in_mbs
  @size_in_mbs
end

#time_created ⇒ DateTime

[Required] The date and time the image was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


116
117
118
 
# File 'lib/oci/core/models/image.rb', line 116

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/core/models/image.rb', line 299

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      base_image_id == other_object.base_image_id &&
      compartment_id == other_object.compartment_id &&
      create_image_allowed == other_object.create_image_allowed &&
      defined_tags == other_object.defined_tags &&
      display_name == other_object.display_name &&
      freeform_tags == other_object.freeform_tags &&
      id == other_object.id &&
      launch_mode == other_object.launch_mode &&
      launch_options == other_object.launch_options &&
      lifecycle_state == other_object.lifecycle_state &&
      operating_system == other_object.operating_system &&
      operating_system_version == other_object.operating_system_version &&
      size_in_mbs == other_object.size_in_mbs &&
      time_created == other_object.time_created
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/core/models/image.rb', line 333

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


320
321
322
 
# File 'lib/oci/core/models/image.rb', line 320

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



326
327
328
 
# File 'lib/oci/core/models/image.rb', line 326

def hash
  [base_image_id, compartment_id, create_image_allowed, defined_tags, display_name, freeform_tags, id, launch_mode, launch_options, lifecycle_state, operating_system, operating_system_version, size_in_mbs, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



358
359
360
361
362
363
364
365
366
 
# File 'lib/oci/core/models/image.rb', line 358

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



352
353
354
 
# File 'lib/oci/core/models/image.rb', line 352

def to_s
  to_hash.to_s
end