Class: OracleBMC::Core::Models::Instance

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/instance.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_RUNNING = 'RUNNING',
LIFECYCLE_STATE_STARTING = 'STARTING',
LIFECYCLE_STATE_STOPPING = 'STOPPING',
LIFECYCLE_STATE_STOPPED = 'STOPPED',
LIFECYCLE_STATE_CREATING_IMAGE = 'CREATING_IMAGE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Instance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
 
# File 'lib/oraclebmc/core/models/instance.rb', line 113

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[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end
  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'extendedMetadata']
    self.extended_metadata = attributes[:'extendedMetadata']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'imageId']
    self.image_id = attributes[:'imageId']
  end
  
  if attributes[:'ipxeScript']
    self.ipxe_script = attributes[:'ipxeScript']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'metadata']
    self.metadata = attributes[:'metadata']
  end
  
  if attributes[:'region']
    self.region = attributes[:'region']
  end
  
  if attributes[:'shape']
    self.shape = attributes[:'shape']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
end

Instance Attribute Details

#availability_domain ⇒ String

The Availability Domain the instance is running in.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


23
24
25
 
# File 'lib/oraclebmc/core/models/instance.rb', line 23

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment that contains the instance.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oraclebmc/core/models/instance.rb', line 27

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable.

Example: ‘My bare metal instance`

Returns:

  • (String) 


34
35
36
 
# File 'lib/oraclebmc/core/models/instance.rb', line 34

def display_name
  @display_name
end

#extended_metadata ⇒ Hash<String, Object>

Additional metadata key/value pairs that you provide. They serve a similar purpose and functionality from fields in the ‘metadata’ object.

They are distinguished from ‘metadata’ fields in that these can be nested JSON objects (whereas ‘metadata’ fields are string/string maps only).

If you don’t need nested metadata values, it is strongly advised to avoid using this object and use the Metadata object instead.

Returns:

  • (Hash<String, Object>) 


43
44
45
 
# File 'lib/oraclebmc/core/models/instance.rb', line 43

def extended_metadata
  @extended_metadata
end

#id ⇒ String

The OCID of the instance.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oraclebmc/core/models/instance.rb', line 47

def id
  @id
end

#image_id ⇒ String

The image used to boot the instance. You can enumerate all available images by calling list_images.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oraclebmc/core/models/instance.rb', line 53

def image_id
  @image_id
end

#ipxe_script ⇒ String

When an Oracle Bare Metal Cloud Services or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

If you want more control over the boot process, you can provide your own custom iPXE script that will run when the instance boots; however, you should be aware that the same iPXE script will run every time an instance boots; not only after the initial LaunchInstance call.

The default iPXE script connects to the instance’s local boot volume over iSCSI and performs a network boot. If you use a custom iPXE script and want to network-boot from the instance’s local boot volume over iSCSI the same way as the default iPXE script, you should use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.

For more information about the Bring Your Own Image feature of Oracle Bare Metal Cloud Services, see [Bring Your Own Image](docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/bringyourownimage.htm).

For more information about iPXE, see ipxe.org.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oraclebmc/core/models/instance.rb', line 79

def ipxe_script
  @ipxe_script
end

#lifecycle_state ⇒ String

The current state of the instance.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oraclebmc/core/models/instance.rb', line 83

def lifecycle_state
  @lifecycle_state
end

#metadata ⇒ Hash<String, String>

Custom metadata that you provide.

Returns:

  • (Hash<String, String>) 


87
88
89
 
# File 'lib/oraclebmc/core/models/instance.rb', line 87

def metadata
  @metadata
end

#region ⇒ String

The region that contains the Availability Domain the instance is running in.

Example: ‘phx`

Returns:

  • (String) 


94
95
96
 
# File 'lib/oraclebmc/core/models/instance.rb', line 94

def region
  @region
end

#shape ⇒ String

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling list_shapes.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oraclebmc/core/models/instance.rb', line 101

def shape
  @shape
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


108
109
110
 
# File 'lib/oraclebmc/core/models/instance.rb', line 108

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oraclebmc/core/models/instance.rb', line 182

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      extended_metadata == other_object.extended_metadata &&
      id == other_object.id &&
      image_id == other_object.image_id &&
      ipxe_script == other_object.ipxe_script &&
      lifecycle_state == other_object.lifecycle_state &&
      metadata == other_object.metadata &&
      region == other_object.region &&
      shape == other_object.shape &&
      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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oraclebmc/core/models/instance.rb', line 214

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


201
202
203
 
# File 'lib/oraclebmc/core/models/instance.rb', line 201

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oraclebmc/core/models/instance.rb', line 207

def hash
  [availability_domain, compartment_id, display_name, extended_metadata, id, image_id, ipxe_script, lifecycle_state, metadata, region, shape, 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



239
240
241
242
243
244
245
246
247
 
# File 'lib/oraclebmc/core/models/instance.rb', line 239

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



233
234
235
 
# File 'lib/oraclebmc/core/models/instance.rb', line 233

def to_s
  to_hash.to_s
end