Class: Kubevirt::V1VirtualMachineSpec

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

Overview

VirtualMachineSpec describes how the proper VirtualMachine should look like

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 = {}) ⇒ V1VirtualMachineSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
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
126
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 81

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

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

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

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

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

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

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

Instance Attribute Details

#data_volume_templatesObject

dataVolumeTemplates is a list of dataVolumes that the VirtualMachineInstance template can reference. DataVolumes in this list are dynamically created for the VirtualMachine and are tied to the VirtualMachine’s life-cycle.



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

def data_volume_templates
  @data_volume_templates
end

#instancetypeObject

Returns the value of attribute instancetype.



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

def instancetype
  @instancetype
end

#preferenceObject

Returns the value of attribute preference.



24
25
26
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 24

def preference
  @preference
end

#run_strategyObject

Running state indicates the requested running state of the VirtualMachineInstance mutually exclusive with Running



27
28
29
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 27

def run_strategy
  @run_strategy
end

#runningObject

Running controls whether the associatied VirtualMachineInstance is created or not Mutually exclusive with RunStrategy Deprecated: VirtualMachineInstance field "Running" is now deprecated, please use RunStrategy instead.



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

def running
  @running
end

#templateObject

Returns the value of attribute template.



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

def template
  @template
end

#update_volumes_strategyObject

UpdateVolumesStrategy is the strategy to apply on volumes updates



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

def update_volumes_strategy
  @update_volumes_strategy
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



51
52
53
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 51

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



56
57
58
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 56

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'data_volume_templates' => :'dataVolumeTemplates',
    :'instancetype' => :'instancetype',
    :'preference' => :'preference',
    :'run_strategy' => :'runStrategy',
    :'running' => :'running',
    :'template' => :'template',
    :'update_volumes_strategy' => :'updateVolumesStrategy'
  }
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



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

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



74
75
76
77
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 74

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'data_volume_templates' => :'Array<V1DataVolumeTemplateSpec>',
    :'instancetype' => :'V1InstancetypeMatcher',
    :'preference' => :'V1PreferenceMatcher',
    :'run_strategy' => :'String',
    :'running' => :'Boolean',
    :'template' => :'V1VirtualMachineInstanceTemplateSpec',
    :'update_volumes_strategy' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data_volume_templates == o.data_volume_templates &&
      instancetype == o.instancetype &&
      preference == o.preference &&
      run_strategy == o.run_strategy &&
      running == o.running &&
      template == o.template &&
      update_volumes_strategy == o.update_volumes_strategy
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 174

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



180
181
182
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 180

def hash
  [data_volume_templates, instancetype, preference, run_strategy, running, template, update_volumes_strategy].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @template.nil?
    invalid_properties.push('invalid value for "template", template 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



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

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



142
143
144
145
146
# File 'lib/kubevirt/models/v1_virtual_machine_spec.rb', line 142

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