Class: OCI::Core::Models::DedicatedVmHost

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

Overview

A dedicated virtual machine host lets you host multiple VM instances on a dedicated server that is not shared with other tenancies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DedicatedVmHost

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 231

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.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

  self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']

  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.dedicated_vm_host_shape = attributes[:'dedicatedVmHostShape'] if attributes[:'dedicatedVmHostShape']

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

  self.dedicated_vm_host_shape = attributes[:'dedicated_vm_host_shape'] if attributes[:'dedicated_vm_host_shape']

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

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

  self.defined_tags = 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.fault_domain = attributes[:'faultDomain'] if attributes[:'faultDomain']

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

  self.fault_domain = attributes[:'fault_domain'] if attributes[:'fault_domain']

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

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

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

  self.placement_constraint_details = attributes[:'placementConstraintDetails'] if attributes[:'placementConstraintDetails']

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

  self.placement_constraint_details = attributes[:'placement_constraint_details'] if attributes[:'placement_constraint_details']

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

  self.capacity_config = attributes[:'capacityConfig'] if attributes[:'capacityConfig']

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

  self.capacity_config = attributes[:'capacity_config'] if attributes[:'capacity_config']

  self.is_memory_encryption_enabled = attributes[:'isMemoryEncryptionEnabled'] unless attributes[:'isMemoryEncryptionEnabled'].nil?
  self.is_memory_encryption_enabled = false if is_memory_encryption_enabled.nil? && !attributes.key?(:'isMemoryEncryptionEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_memory_encryption_enabled = attributes[:'is_memory_encryption_enabled'] unless attributes[:'is_memory_encryption_enabled'].nil?
  self.is_memory_encryption_enabled = false if is_memory_encryption_enabled.nil? && !attributes.key?(:'isMemoryEncryptionEnabled') && !attributes.key?(:'is_memory_encryption_enabled') # rubocop:disable Style/StringLiterals

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

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

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

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

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

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

  self.total_ocpus = attributes[:'totalOcpus'] if attributes[:'totalOcpus']

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

  self.total_ocpus = attributes[:'total_ocpus'] if attributes[:'total_ocpus']

  self.remaining_ocpus = attributes[:'remainingOcpus'] if attributes[:'remainingOcpus']

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

  self.remaining_ocpus = attributes[:'remaining_ocpus'] if attributes[:'remaining_ocpus']

  self.total_memory_in_gbs = attributes[:'totalMemoryInGBs'] if attributes[:'totalMemoryInGBs']

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

  self.total_memory_in_gbs = attributes[:'total_memory_in_gbs'] if attributes[:'total_memory_in_gbs']

  self.remaining_memory_in_gbs = attributes[:'remainingMemoryInGBs'] if attributes[:'remainingMemoryInGBs']

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

  self.remaining_memory_in_gbs = attributes[:'remaining_memory_in_gbs'] if attributes[:'remaining_memory_in_gbs']

  self.total_local_volume_in_gbs = attributes[:'totalLocalVolumeInGBs'] if attributes[:'totalLocalVolumeInGBs']

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

  self.total_local_volume_in_gbs = attributes[:'total_local_volume_in_gbs'] if attributes[:'total_local_volume_in_gbs']

  self.remaining_local_volume_in_gbs = attributes[:'remainingLocalVolumeInGBs'] if attributes[:'remainingLocalVolumeInGBs']

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

  self.remaining_local_volume_in_gbs = attributes[:'remaining_local_volume_in_gbs'] if attributes[:'remaining_local_volume_in_gbs']

  self.capacity_bins = attributes[:'capacityBins'] if attributes[:'capacityBins']

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

  self.capacity_bins = attributes[:'capacity_bins'] if attributes[:'capacity_bins']

  self.compute_bare_metal_host_id = attributes[:'computeBareMetalHostId'] if attributes[:'computeBareMetalHostId']

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

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain the dedicated virtual machine host is running in.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


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

def availability_domain
  @availability_domain
end

#capacity_bins ⇒ Array<OCI::Core::Models::CapacityBin>

A list of total and remaining CPU, memory, and local volume per capacity bucket.

Returns:



139
140
141
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 139

def capacity_bins
  @capacity_bins
end

#capacity_config ⇒ String

The capacity configuration selected to be configured for the Dedicated Virtual Machine host. Run list_dedicated_vm_host_shapes API to see details of this capacity configuration.

Returns:

  • (String) 


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

def capacity_config
  @capacity_config
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the dedicated virtual machine host.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 33

def compartment_id
  @compartment_id
end

#compute_bare_metal_host_id ⇒ String

The compute bare metal host OCID of the dedicated virtual machine host.

Returns:

  • (String) 


144
145
146
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 144

def compute_bare_metal_host_id
  @compute_bare_metal_host_id
end

#dedicated_vm_host_shape ⇒ String

[Required] The dedicated virtual machine host shape. The shape determines the number of CPUs and other resources available for VMs.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 39

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

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#fault_domain ⇒ String

The fault domain for the dedicated virtual machine host's assigned instances. For more information, see Fault Domains.

If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host, delete it, and then create a new dedicated virtual machine host in the preferred fault domain.

To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns:

  • (String) 


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

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

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the dedicated VM host.

Returns:

  • (String) 


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

def id
  @id
end

#is_memory_encryption_enabled ⇒ BOOLEAN

Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Confidential VMs. If true, only Confidential VMs can be launched. If false, Confidential VMs cannot be launched.

Returns:

  • (BOOLEAN) 


92
93
94
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 92

def is_memory_encryption_enabled
  @is_memory_encryption_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the dedicated VM host.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 97

def lifecycle_state
  @lifecycle_state
end

#placement_constraint_details ⇒ OCI::Core::Models::PlacementConstraintDetails

Returns:



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

def placement_constraint_details
  @placement_constraint_details
end

#remaining_local_volume_in_gbs ⇒ Float

The remaining local volume of the dedicated VM host, in GBs.

Returns:

  • (Float) 


134
135
136
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 134

def remaining_local_volume_in_gbs
  @remaining_local_volume_in_gbs
end

#remaining_memory_in_gbs ⇒ Float

The remaining memory of the dedicated VM host, in GBs.

Returns:

  • (Float) 


124
125
126
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 124

def remaining_memory_in_gbs
  @remaining_memory_in_gbs
end

#remaining_ocpus ⇒ Float

[Required] The available OCPUs of the dedicated VM host.

Returns:

  • (Float) 


114
115
116
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 114

def remaining_ocpus
  @remaining_ocpus
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 104

def time_created
  @time_created
end

#total_local_volume_in_gbs ⇒ Float

The total local volume of the dedicated VM host, in GBs.

Returns:

  • (Float) 


129
130
131
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 129

def total_local_volume_in_gbs
  @total_local_volume_in_gbs
end

#total_memory_in_gbs ⇒ Float

The total memory of the dedicated VM host, in GBs.

Returns:

  • (Float) 


119
120
121
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 119

def total_memory_in_gbs
  @total_memory_in_gbs
end

#total_ocpus ⇒ Float

[Required] The total OCPUs of the dedicated VM host.

Returns:

  • (Float) 


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

def total_ocpus
  @total_ocpus
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 147

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'dedicated_vm_host_shape': :'dedicatedVmHostShape',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'fault_domain': :'faultDomain',
    'freeform_tags': :'freeformTags',
    'placement_constraint_details': :'placementConstraintDetails',
    'id': :'id',
    'capacity_config': :'capacityConfig',
    'is_memory_encryption_enabled': :'isMemoryEncryptionEnabled',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'total_ocpus': :'totalOcpus',
    'remaining_ocpus': :'remainingOcpus',
    'total_memory_in_gbs': :'totalMemoryInGBs',
    'remaining_memory_in_gbs': :'remainingMemoryInGBs',
    'total_local_volume_in_gbs': :'totalLocalVolumeInGBs',
    'remaining_local_volume_in_gbs': :'remainingLocalVolumeInGBs',
    'capacity_bins': :'capacityBins',
    'compute_bare_metal_host_id': :'computeBareMetalHostId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 176

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'dedicated_vm_host_shape': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'fault_domain': :'String',
    'freeform_tags': :'Hash<String, String>',
    'placement_constraint_details': :'OCI::Core::Models::PlacementConstraintDetails',
    'id': :'String',
    'capacity_config': :'String',
    'is_memory_encryption_enabled': :'BOOLEAN',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'total_ocpus': :'Float',
    'remaining_ocpus': :'Float',
    'total_memory_in_gbs': :'Float',
    'remaining_memory_in_gbs': :'Float',
    'total_local_volume_in_gbs': :'Float',
    'remaining_local_volume_in_gbs': :'Float',
    'capacity_bins': :'Array<OCI::Core::Models::CapacityBin>',
    'compute_bare_metal_host_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 382

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    dedicated_vm_host_shape == other.dedicated_vm_host_shape &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    fault_domain == other.fault_domain &&
    freeform_tags == other.freeform_tags &&
    placement_constraint_details == other.placement_constraint_details &&
    id == other.id &&
    capacity_config == other.capacity_config &&
    is_memory_encryption_enabled == other.is_memory_encryption_enabled &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    total_ocpus == other.total_ocpus &&
    remaining_ocpus == other.remaining_ocpus &&
    total_memory_in_gbs == other.total_memory_in_gbs &&
    remaining_memory_in_gbs == other.remaining_memory_in_gbs &&
    total_local_volume_in_gbs == other.total_local_volume_in_gbs &&
    remaining_local_volume_in_gbs == other.remaining_local_volume_in_gbs &&
    capacity_bins == other.capacity_bins &&
    compute_bare_metal_host_id == other.compute_bare_metal_host_id
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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 432

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


412
413
414
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 412

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



421
422
423
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 421

def hash
  [availability_domain, compartment_id, dedicated_vm_host_shape, defined_tags, display_name, fault_domain, freeform_tags, placement_constraint_details, id, capacity_config, is_memory_encryption_enabled, lifecycle_state, time_created, total_ocpus, remaining_ocpus, total_memory_in_gbs, remaining_memory_in_gbs, total_local_volume_in_gbs, remaining_local_volume_in_gbs, capacity_bins, compute_bare_metal_host_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



465
466
467
468
469
470
471
472
473
474
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 465

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



459
460
461
 
# File 'lib/oci/core/models/dedicated_vm_host.rb', line 459

def to_s
  to_hash.to_s
end