Class: Kubevirt::V1beta1VirtualMachineInstancetypeSpec

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb

Overview

VirtualMachineInstancetypeSpec is a description of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype. CPU and Memory are required attributes with both requiring that their Guest attribute is defined, ensuring a number of vCPUs and amount of RAM is always provided by each 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 = {}) ⇒ V1beta1VirtualMachineInstancetypeSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 95

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::V1beta1VirtualMachineInstancetypeSpec` 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::V1beta1VirtualMachineInstancetypeSpec`. 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?(:'annotations')
    if (value = attributes[:'annotations']).is_a?(Hash)
      self.annotations = value
    end
  end

  if attributes.key?(:'cpu')
    self.cpu = attributes[:'cpu']
  else
    self.cpu = nil
  end

  if attributes.key?(:'gpus')
    if (value = attributes[:'gpus']).is_a?(Array)
      self.gpus = value
    end
  end

  if attributes.key?(:'host_devices')
    if (value = attributes[:'host_devices']).is_a?(Array)
      self.host_devices = value
    end
  end

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

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

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

  if attributes.key?(:'memory')
    self.memory = attributes[:'memory']
  else
    self.memory = nil
  end

  if attributes.key?(:'node_selector')
    if (value = attributes[:'node_selector']).is_a?(Hash)
      self.node_selector = value
    end
  end

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

Instance Attribute Details

#annotations ⇒ Object

Optionally defines the required Annotations to be used by the instance type and applied to the VirtualMachineInstance



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

def annotations
  @annotations
end

#cpu ⇒ Object

Returns the value of attribute cpu.



22
23
24
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 22

def cpu
  @cpu
end

#gpus ⇒ Object

Optionally defines any GPU devices associated with the instancetype.



25
26
27
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 25

def gpus
  @gpus
end

#host_devices ⇒ Object

Optionally defines any HostDevices associated with the instancetype.



28
29
30
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 28

def host_devices
  @host_devices
end

#io_threads ⇒ Object

Returns the value of attribute io_threads.



30
31
32
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 30

def io_threads
  @io_threads
end

#io_threads_policy ⇒ Object

Optionally defines the IOThreadsPolicy to be used by the instancetype.



33
34
35
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 33

def io_threads_policy
  @io_threads_policy
end

#launch_security ⇒ Object

Returns the value of attribute launch_security.



35
36
37
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 35

def launch_security
  @launch_security
end

#memory ⇒ Object

Returns the value of attribute memory.



37
38
39
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 37

def memory
  @memory
end

#node_selector ⇒ Object

NodeSelector is a selector which must be true for the vmi to fit on a node. Selector which must match a node’s labels for the vmi to be scheduled on that node. More info: kubernetes.io/docs/concepts/configuration/assign-pod-node/ NodeSelector is the name of the custom node selector for the instancetype.



40
41
42
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 40

def node_selector
  @node_selector
end

#scheduler_name ⇒ Object

If specified, the VMI will be dispatched by specified scheduler. If not specified, the VMI will be dispatched by default scheduler. SchedulerName is the name of the custom K8s scheduler for the instancetype.



43
44
45
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 43

def scheduler_name
  @scheduler_name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 46

def self.attribute_map
  {
    :'annotations' => :'annotations',
    :'cpu' => :'cpu',
    :'gpus' => :'gpus',
    :'host_devices' => :'hostDevices',
    :'io_threads' => :'ioThreads',
    :'io_threads_policy' => :'ioThreadsPolicy',
    :'launch_security' => :'launchSecurity',
    :'memory' => :'memory',
    :'node_selector' => :'nodeSelector',
    :'scheduler_name' => :'schedulerName'
  }
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 239

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_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 72

def self.openapi_types
  {
    :'annotations' => :'Hash<String, String>',
    :'cpu' => :'V1beta1CPUInstancetype',
    :'gpus' => :'Array<V1GPU>',
    :'host_devices' => :'Array<V1HostDevice>',
    :'io_threads' => :'V1DiskIOThreads',
    :'io_threads_policy' => :'String',
    :'launch_security' => :'V1LaunchSecurity',
    :'memory' => :'V1beta1MemoryInstancetype',
    :'node_selector' => :'Hash<String, String>',
    :'scheduler_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      annotations == o.annotations &&
      cpu == o.cpu &&
      gpus == o.gpus &&
      host_devices == o.host_devices &&
      io_threads == o.io_threads &&
      io_threads_policy == o.io_threads_policy &&
      launch_security == o.launch_security &&
      memory == o.memory &&
      node_selector == o.node_selector &&
      scheduler_name == o.scheduler_name
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 232

def hash
  [annotations, cpu, gpus, host_devices, io_threads, io_threads_policy, launch_security, memory, node_selector, scheduler_name].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 164

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

  if @memory.nil?
    invalid_properties.push('invalid value for "memory", memory cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 261

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



180
181
182
183
184
185
 
# File 'lib/kubevirt/models/v1beta1_virtual_machine_instancetype_spec.rb', line 180

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