Class: OCI::Core::Models::DedicatedVmHostSummary

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

Overview

A dedicated virtual machine (VM) host lets you host multiple 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 = {}) ⇒ DedicatedVmHostSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 186

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

  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.is_burstable = attributes[:'isBurstable'] unless attributes[:'isBurstable'].nil?
  self.is_burstable = false if is_burstable.nil? && !attributes.key?(:'isBurstable') # rubocop:disable Style/StringLiterals

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

  self.is_burstable = attributes[:'is_burstable'] unless attributes[:'is_burstable'].nil?
  self.is_burstable = false if is_burstable.nil? && !attributes.key?(:'isBurstable') && !attributes.key?(:'is_burstable') # 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.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_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.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']
end

Instance Attribute Details

#availability_domain ⇒ String

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

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 28

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#dedicated_vm_host_shape ⇒ String

[Required] The shape of the dedicated VM host. 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_summary.rb', line 39

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


45
46
47
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 45

def display_name
  @display_name
end

#fault_domain ⇒ String

The fault domain for the dedicated VM 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 VM host, delete it and create a new dedicated VM 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) 


57
58
59
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 57

def fault_domain
  @fault_domain
end

#id ⇒ String

[Required] The OCID of the dedicated VM host.

Returns:

  • (String) 


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

def id
  @id
end

#is_burstable ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


72
73
74
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 72

def is_burstable
  @is_burstable
end

#is_memory_encryption_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


67
68
69
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 67

def is_memory_encryption_enabled
  @is_memory_encryption_enabled
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#remaining_local_volume_in_gbs ⇒ Float

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

Returns:

  • (Float) 


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

def remaining_local_volume_in_gbs
  @remaining_local_volume_in_gbs
end

#remaining_memory_in_gbs ⇒ Float

The current available memory of the dedicated VM host, in GBs.

Returns:

  • (Float) 


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

def remaining_memory_in_gbs
  @remaining_memory_in_gbs
end

#remaining_ocpus ⇒ Float

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

Returns:

  • (Float) 


89
90
91
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 89

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) 


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

def time_created
  @time_created
end

#total_local_volume_in_gbs ⇒ Float

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

Returns:

  • (Float) 


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

def total_local_volume_in_gbs
  @total_local_volume_in_gbs
end

#total_memory_in_gbs ⇒ Float

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

Returns:

  • (Float) 


99
100
101
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 99

def total_memory_in_gbs
  @total_memory_in_gbs
end

#total_ocpus ⇒ Float

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

Returns:

  • (Float) 


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

def total_ocpus
  @total_ocpus
end

Class Method Details

.attribute_map ⇒ Object

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'dedicated_vm_host_shape': :'dedicatedVmHostShape',
    'display_name': :'displayName',
    'fault_domain': :'faultDomain',
    'id': :'id',
    'is_memory_encryption_enabled': :'isMemoryEncryptionEnabled',
    'is_burstable': :'isBurstable',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'remaining_ocpus': :'remainingOcpus',
    'total_ocpus': :'totalOcpus',
    'total_memory_in_gbs': :'totalMemoryInGBs',
    'remaining_memory_in_gbs': :'remainingMemoryInGBs',
    'total_local_volume_in_gbs': :'totalLocalVolumeInGBs',
    'remaining_local_volume_in_gbs': :'remainingLocalVolumeInGBs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 141

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'dedicated_vm_host_shape': :'String',
    'display_name': :'String',
    'fault_domain': :'String',
    'id': :'String',
    'is_memory_encryption_enabled': :'BOOLEAN',
    'is_burstable': :'BOOLEAN',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'remaining_ocpus': :'Float',
    'total_ocpus': :'Float',
    'total_memory_in_gbs': :'Float',
    'remaining_memory_in_gbs': :'Float',
    'total_local_volume_in_gbs': :'Float',
    'remaining_local_volume_in_gbs': :'Float'
    # 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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 309

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 &&
    display_name == other.display_name &&
    fault_domain == other.fault_domain &&
    id == other.id &&
    is_memory_encryption_enabled == other.is_memory_encryption_enabled &&
    is_burstable == other.is_burstable &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    remaining_ocpus == other.remaining_ocpus &&
    total_ocpus == other.total_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
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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 354

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


334
335
336
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 334

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



343
344
345
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 343

def hash
  [availability_domain, compartment_id, dedicated_vm_host_shape, display_name, fault_domain, id, is_memory_encryption_enabled, is_burstable, lifecycle_state, time_created, remaining_ocpus, total_ocpus, total_memory_in_gbs, remaining_memory_in_gbs, total_local_volume_in_gbs, remaining_local_volume_in_gbs].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 387

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



381
382
383
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 381

def to_s
  to_hash.to_s
end