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 that enables you to host multiple instances on a dedicated host instance 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):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :dedicated_vm_host_shape (String) —

    The value to assign to the #dedicated_vm_host_shape property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :fault_domain (String) —

    The value to assign to the #fault_domain property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :remaining_ocpus (Float) —

    The value to assign to the #remaining_ocpus property

  • :total_ocpus (Float) —

    The value to assign to the #total_ocpus property



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
169
170
171
172
173
174
175
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
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 139

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.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']
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) 


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

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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) 


38
39
40
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 38

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.

Example: My DVH

Returns:

  • (String) 


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

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) 


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

def fault_domain
  @fault_domain
end

#id ⇒ String

[Required] The OCID of the dedicated VM host.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#remaining_ocpus ⇒ Float

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

Returns:

  • (Float) 


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

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) 


75
76
77
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 75

def time_created
  @time_created
end

#total_ocpus ⇒ Float

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

Returns:

  • (Float) 


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

def total_ocpus
  @total_ocpus
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 88

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',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'remaining_ocpus': :'remainingOcpus',
    'total_ocpus': :'totalOcpus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 106

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',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'remaining_ocpus': :'Float',
    'total_ocpus': :'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



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

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 &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    remaining_ocpus == other.remaining_ocpus &&
    total_ocpus == other.total_ocpus
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 261

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


241
242
243
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 241

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



250
251
252
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 250

def hash
  [availability_domain, compartment_id, dedicated_vm_host_shape, display_name, fault_domain, id, lifecycle_state, time_created, remaining_ocpus, total_ocpus].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 294

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



288
289
290
 
# File 'lib/oci/core/models/dedicated_vm_host_summary.rb', line 288

def to_s
  to_hash.to_s
end