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

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

Constant Summary collapse

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/core/models/image.rb', line 73

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[:'displayName']
    self.display_name = attributes[:'displayName']
  end

  if attributes[:'id']
    self.id = attributes[:'id']
  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) 


18
19
20
 
# File 'lib/oci/core/models/image.rb', line 18

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) 


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

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) 


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

def create_image_allowed
  @create_image_allowed
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) 


40
41
42
 
# File 'lib/oci/core/models/image.rb', line 40

def display_name
  @display_name
end

#id ⇒ String

The OCID of the image.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/image.rb', line 47

def lifecycle_state
  @lifecycle_state
end

#operating_system ⇒ String

The image’s operating system.

Example: ‘Oracle Linux`

Returns:

  • (String) 


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

def operating_system
  @operating_system
end

#operating_system_version ⇒ String

The image’s operating system version.

Example: ‘7.2`

Returns:

  • (String) 


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

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) 


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

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



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/core/models/image.rb', line 129

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 &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/core/models/image.rb', line 158

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.send("#{key}=", 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.send("#{key}=", 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


145
146
147
 
# File 'lib/oci/core/models/image.rb', line 145

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/oci/core/models/image.rb', line 151

def hash
  [base_image_id, compartment_id, create_image_allowed, display_name, id, 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



183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/core/models/image.rb', line 183

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



177
178
179
 
# File 'lib/oci/core/models/image.rb', line 177

def to_s
  to_hash.to_s
end