Class: Kubevirt::V1beta1CPUInstancetype

Inherits:
ApiModelBase show all
Defined in:
lib/kubevirt/models/v1beta1_cpu_instancetype.rb

Overview

CPUInstancetype contains the CPU related configuration of a given VirtualMachineInstancetypeSpec. Guest is a required attribute and defines the number of vCPUs to be exposed to the guest by the instancetype.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ V1beta1CPUInstancetype

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
122
123
124
125
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 82

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::V1beta1CPUInstancetype` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Kubevirt::V1beta1CPUInstancetype`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'dedicated_cpu_placement')
    self.dedicated_cpu_placement = attributes[:'dedicated_cpu_placement']
  end

  if attributes.key?(:'guest')
    self.guest = attributes[:'guest']
  else
    self.guest = 0
  end

  if attributes.key?(:'isolate_emulator_thread')
    self.isolate_emulator_thread = attributes[:'isolate_emulator_thread']
  end

  if attributes.key?(:'max_sockets')
    self.max_sockets = attributes[:'max_sockets']
  end

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  end

  if attributes.key?(:'numa')
    self.numa = attributes[:'numa']
  end

  if attributes.key?(:'realtime')
    self.realtime = attributes[:'realtime']
  end
end

Instance Attribute Details

#dedicated_cpu_placementObject

DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node with enough dedicated pCPUs and pin the vCPUs to it.



20
21
22
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 20

def dedicated_cpu_placement
  @dedicated_cpu_placement
end

#guestObject

Required number of vCPUs to expose to the guest. The resulting CPU topology being derived from the optional PreferredCPUTopology attribute of CPUPreferences that itself defaults to PreferSockets.



23
24
25
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 23

def guest
  @guest
end

#isolate_emulator_threadObject

IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place the emulator thread on it.



26
27
28
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 26

def isolate_emulator_thread
  @isolate_emulator_thread
end

#max_socketsObject

MaxSockets specifies the maximum amount of sockets that can be hotplugged



29
30
31
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 29

def max_sockets
  @max_sockets
end

#modelObject

Model specifies the CPU model inside the VMI. List of available models github.com/libvirt/libvirt/tree/master/src/cpu_map. It is possible to specify special cases like "host-passthrough" to get the same CPU as the node and "host-model" to get CPU closest to the node one. Defaults to host-model.



32
33
34
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 32

def model
  @model
end

#numaObject

Returns the value of attribute numa.



34
35
36
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 34

def numa
  @numa
end

#realtimeObject

Returns the value of attribute realtime.



36
37
38
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 36

def realtime
  @realtime
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



52
53
54
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 52

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



57
58
59
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 57

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



39
40
41
42
43
44
45
46
47
48
49
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 39

def self.attribute_map
  {
    :'dedicated_cpu_placement' => :'dedicatedCPUPlacement',
    :'guest' => :'guest',
    :'isolate_emulator_thread' => :'isolateEmulatorThread',
    :'max_sockets' => :'maxSockets',
    :'model' => :'model',
    :'numa' => :'numa',
    :'realtime' => :'realtime'
  }
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 186

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



75
76
77
78
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 75

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 62

def self.openapi_types
  {
    :'dedicated_cpu_placement' => :'Boolean',
    :'guest' => :'Integer',
    :'isolate_emulator_thread' => :'Boolean',
    :'max_sockets' => :'Integer',
    :'model' => :'String',
    :'numa' => :'V1NUMA',
    :'realtime' => :'V1Realtime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



159
160
161
162
163
164
165
166
167
168
169
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      dedicated_cpu_placement == o.dedicated_cpu_placement &&
      guest == o.guest &&
      isolate_emulator_thread == o.isolate_emulator_thread &&
      max_sockets == o.max_sockets &&
      model == o.model &&
      numa == o.numa &&
      realtime == o.realtime
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 173

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



179
180
181
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 179

def hash
  [dedicated_cpu_placement, guest, isolate_emulator_thread, max_sockets, model, numa, realtime].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



129
130
131
132
133
134
135
136
137
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 129

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @guest.nil?
    invalid_properties.push('invalid value for "guest", guest cannot be nil.')
  end

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 208

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



141
142
143
144
145
# File 'lib/kubevirt/models/v1beta1_cpu_instancetype.rb', line 141

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @guest.nil?
  true
end