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

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

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



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
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/core/models/image.rb', line 106

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

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

  if attributes[:'createImageAllowed']
    self.create_image_allowed = attributes[:'createImageAllowed']
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#base_image_id ⇒ String

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/core/models/image.rb', line 24

def base_image_id
  @base_image_id
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/core/models/image.rb', line 29

def compartment_id
  @compartment_id
end

#create_image_allowed ⇒ BOOLEAN

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) 


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

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>>) 


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

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) 


53
54
55
 
# File 'lib/oci/core/models/image.rb', line 53

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>) 


62
63
64
 
# File 'lib/oci/core/models/image.rb', line 62

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the image.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/core/models/image.rb', line 66

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) 


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

def launch_mode
  @launch_mode
end

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

Returns:



77
78
79
 
# File 'lib/oci/core/models/image.rb', line 77

def launch_options
  @launch_options
end

#lifecycle_state ⇒ String

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#operating_system ⇒ String

The image’s operating system.

Example: ‘Oracle Linux`

Returns:

  • (String) 


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

def operating_system
  @operating_system
end

#operating_system_version ⇒ String

The image’s operating system version.

Example: ‘7.2`

Returns:

  • (String) 


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

def operating_system_version
  @operating_system_version
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/core/models/image.rb', line 188

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 &&
      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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/core/models/image.rb', line 221

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


208
209
210
 
# File 'lib/oci/core/models/image.rb', line 208

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



214
215
216
 
# File 'lib/oci/core/models/image.rb', line 214

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, 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



246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/core/models/image.rb', line 246

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



240
241
242
 
# File 'lib/oci/core/models/image.rb', line 240

def to_s
  to_hash.to_s
end