Class: Kubevirt::V1HostDevice

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
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
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 72

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

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

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

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

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

Instance Attribute Details

#claim_name ⇒ Object

ClaimName needs to be provided from the list vmi.spec.resourceClaims[].name where this device is allocated



19
20
21
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 19

def claim_name
  @claim_name
end

#device_name ⇒ Object

DeviceName is the name of the device provisioned by device-plugins



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

def device_name
  @device_name
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#request_name ⇒ Object

RequestName needs to be provided from resourceClaim.spec.devices.requests[].name where this device is requested



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

def request_name
  @request_name
end

#tag ⇒ Object

If specified, the virtual network interface address and its tag will be provided to the guest via config drive



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

def tag
  @tag
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



44
45
46
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 44

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 49

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 33

def self.attribute_map
  {
    :'claim_name' => :'claimName',
    :'device_name' => :'deviceName',
    :'name' => :'name',
    :'request_name' => :'requestName',
    :'tag' => :'tag'
  }
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



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

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



65
66
67
68
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 54

def self.openapi_types
  {
    :'claim_name' => :'String',
    :'device_name' => :'String',
    :'name' => :'String',
    :'request_name' => :'String',
    :'tag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      claim_name == o.claim_name &&
      device_name == o.device_name &&
      name == o.name &&
      request_name == o.request_name &&
      tag == o.tag
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


153
154
155
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 153

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



159
160
161
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 159

def hash
  [claim_name, device_name, name, request_name, tag].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



111
112
113
114
115
116
117
118
119
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 111

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



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

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



123
124
125
126
127
 
# File 'lib/kubevirt/models/v1_host_device.rb', line 123

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