Class: Kubevirt::V1PciHostDevice

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

Overview

PciHostDevice represents a host PCI device allowed for passthrough

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

Initializes the object



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 64

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

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

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

Instance Attribute Details

#external_resource_provider ⇒ Object

If true, KubeVirt will leave the allocation and monitoring to an external device plugin



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

def external_resource_provider
  @external_resource_provider
end

#pci_vendor_selector ⇒ Object

The vendor_id:product_id tuple of the PCI device



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

def pci_vendor_selector
  @pci_vendor_selector
end

#resource_name ⇒ Object

The name of the resource that is representing the device. Exposed by a device plugin and requested by VMs. Typically of the form vendor.com/product_name



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

def resource_name
  @resource_name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 29

def self.attribute_map
  {
    :'external_resource_provider' => :'externalResourceProvider',
    :'pci_vendor_selector' => :'pciVendorSelector',
    :'resource_name' => :'resourceName'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 165

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 48

def self.openapi_types
  {
    :'external_resource_provider' => :'Boolean',
    :'pci_vendor_selector' => :'String',
    :'resource_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_resource_provider == o.external_resource_provider &&
      pci_vendor_selector == o.pci_vendor_selector &&
      resource_name == o.resource_name
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


152
153
154
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



158
159
160
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 158

def hash
  [external_resource_provider, pci_vendor_selector, resource_name].hash
end

#list_invalid_properties ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 97

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 187

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



113
114
115
116
117
118
 
# File 'lib/kubevirt/models/v1_pci_host_device.rb', line 113

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